Helix SwarmHelix Swarm

HWSStrings.html

  • //
  • guest/
  • doug_scheirer/
  • helix-web-services/
  • main/
  • build/
  • doc/
  • helix_web_services/
  • HWSStrings.html #11
  • View
  • Commits
  • Open Download .zip Download (11 KB) 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  4.   <head>
  5.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <title>
  7.   Module: HWSStrings
  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#!HWSStrings.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 (H)</a> &raquo;
  35.     
  36.     
  37.     <span class="title">HWSStrings</span>
  38.   
  39.  
  40.   <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
  41. </div>
  42.  
  43.       <div id="search">
  44.   
  45.     <a class="full_list_link" id="class_list_link"
  46.         href="class_list.html">
  47.       Class List
  48.     </a>
  49.   
  50.     <a class="full_list_link" id="method_list_link"
  51.         href="method_list.html">
  52.       Method List
  53.     </a>
  54.   
  55.     <a class="full_list_link" id="file_list_link"
  56.         href="file_list.html">
  57.       File List
  58.     </a>
  59.   
  60. </div>
  61.       <div class="clear"></div>
  62.     </div>
  63.  
  64.     <iframe id="search_frame"></iframe>
  65.  
  66.     <div id="content"><h1>Module: HWSStrings
  67.   
  68.   
  69.   
  70. </h1>
  71.  
  72. <dl class="box">
  73.   
  74.   
  75.     
  76.   
  77.     
  78.   
  79.   
  80.   
  81.     <dt class="r1 last">Defined in:</dt>
  82.     <dd class="r1 last">lib/hws_strings.rb</dd>
  83.   
  84. </dl>
  85. <div class="clear"></div>
  86.  
  87.  
  88.   <h2>Constant Summary</h2>
  89.   
  90.     <dl class="constants">
  91.       
  92.         <dt id="DEFAULT_ILLEGAL_CHARS-constant" class="">DEFAULT_ILLEGAL_CHARS =
  93.           <div class="docstring">
  94.   <div class="discussion">
  95.     
  96. <p>These constants are used as the default configuration for the
  97. component_encode and component_decode methods.</p>
  98.  
  99.  
  100.   </div>
  101. </div>
  102. <div class="tags">
  103.   
  104.  
  105. </div>
  106.         </dt>
  107.         <dd><pre class="code"><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>~</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'> </span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span></pre></dd>
  108.       
  109.         <dt id="DEFAULT_ESCAPE-constant" class="">DEFAULT_ESCAPE =
  110.           
  111.         </dt>
  112.         <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>~</span><span class='tstring_end'>&#39;</span></span></pre></dd>
  113.       
  114.     </dl>
  115.   
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.   
  124.     <h2>
  125.       Class Method Summary
  126.       <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
  127.     </h2>
  128.  
  129.     <ul class="summary">
  130.       
  131.         <li class="public ">
  132.   <span class="summary_signature">
  133.     
  134.       <a href="#component_decode-class_method" title="component_decode (class method)">+ (Object) <strong>component_decode</strong>(str, escape = DEFAULT_ESCAPE, illegal_characters = DEFAULT_ILLEGAL_CHARS, base = 16) </a>
  135.     
  136.  
  137.     
  138.   </span>
  139.   
  140.   
  141.   
  142.   
  143.   
  144.   
  145.   
  146.  
  147.   
  148.     <span class="summary_desc"><div class='inline'>
  149. <p>Decodes a string encoded with component_encode.</p>
  150. </div></span>
  151.   
  152. </li>
  153.  
  154.       
  155.         <li class="public ">
  156.   <span class="summary_signature">
  157.     
  158.       <a href="#component_encode-class_method" title="component_encode (class method)">+ (Object) <strong>component_encode</strong>(str, illegal_characters: DEFAULT_ILLEGAL_CHARS) </a>
  159.     
  160.  
  161.     
  162.   </span>
  163.   
  164.   
  165.   
  166.   
  167.   
  168.   
  169.   
  170.  
  171.   
  172.     <span class="summary_desc"><div class='inline'>
  173. <p>Encode the string to make it usable as a single path in a URL.</p>
  174. </div></span>
  175.   
  176. </li>
  177.  
  178.       
  179.     </ul>
  180.   
  181.  
  182.  
  183.  
  184.   <div id="class_method_details" class="method_details_list">
  185.     <h2>Class Method Details</h2>
  186.  
  187.     
  188.       <div class="method_details first">
  189.   <h3 class="signature first" id="component_decode-class_method">
  190.   
  191.     + (<tt>Object</tt>) <strong>component_decode</strong>(str, escape = DEFAULT_ESCAPE, illegal_characters = DEFAULT_ILLEGAL_CHARS, base = 16) 
  192.   
  193.  
  194.   
  195.  
  196.   
  197. </h3><div class="docstring">
  198.   <div class="discussion">
  199.     
  200. <p>Decodes a string encoded with component_encode.</p>
  201.  
  202.  
  203.   </div>
  204. </div>
  205. <div class="tags">
  206.   
  207.  
  208. </div><table class="source_code">
  209.   <tr>
  210.     <td>
  211.       <pre class="lines">
  212.  
  213.  
  214. 29
  215. 30
  216. 31
  217. 32
  218. 33
  219. 34
  220. 35
  221. 36</pre>
  222.     </td>
  223.     <td>
  224.       <pre class="code"><span class="info file"># File 'lib/hws_strings.rb', line 29</span>
  225.  
  226. <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_component_decode'>component_decode</span><span class='lparen'>(</span><span class='id identifier rubyid_str'>str</span><span class='comma'>,</span> <span class='id identifier rubyid_escape'>escape</span> <span class='op'>=</span> <span class='const'>DEFAULT_ESCAPE</span><span class='comma'>,</span>
  227.     <span class='id identifier rubyid_illegal_characters'>illegal_characters</span> <span class='op'>=</span> <span class='const'>DEFAULT_ILLEGAL_CHARS</span><span class='comma'>,</span> <span class='id identifier rubyid_base'>base</span><span class='op'>=</span><span class='int'>16</span><span class='rparen'>)</span>
  228.   <span class='id identifier rubyid_escape_map'>escape_map</span> <span class='op'>=</span> <span class='const'>Hash</span><span class='lbracket'>[</span><span class='id identifier rubyid_illegal_characters'>illegal_characters</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_c'>c</span><span class='op'>|</span> <span class='lbracket'>[</span><span class='id identifier rubyid_c'>c</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_escape'>escape</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_c'>c</span><span class='period'>.</span><span class='id identifier rubyid_ord'>ord</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='lparen'>(</span><span class='id identifier rubyid_base'>base</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='rbrace'>}</span><span class='rbracket'>]</span>
  229.   <span class='id identifier rubyid_escape_map'>escape_map</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_ch'>ch</span><span class='comma'>,</span> <span class='id identifier rubyid_escaped'>escaped</span><span class='op'>|</span>
  230.     <span class='id identifier rubyid_str'>str</span> <span class='op'>=</span> <span class='id identifier rubyid_str'>str</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='id identifier rubyid_escaped'>escaped</span><span class='comma'>,</span> <span class='id identifier rubyid_ch'>ch</span><span class='rparen'>)</span>
  231.   <span class='kw'>end</span>
  232.   <span class='id identifier rubyid_str'>str</span>
  233. <span class='kw'>end</span></pre>
  234.     </td>
  235.   </tr>
  236. </table>
  237. </div>
  238.     
  239.       <div class="method_details ">
  240.   <h3 class="signature " id="component_encode-class_method">
  241.   
  242.     + (<tt>Object</tt>) <strong>component_encode</strong>(str, illegal_characters: DEFAULT_ILLEGAL_CHARS) 
  243.   
  244.  
  245.   
  246.  
  247.   
  248. </h3><div class="docstring">
  249.   <div class="discussion">
  250.     
  251. <p>Encode the string to make it usable as a single path in a URL.</p>
  252.  
  253. <p>This a simple scheme that should allow you to match the string in a single
  254. path variable easily, in a way that should not be messed with by your web
  255. framework.</p>
  256.  
  257. <p>Many characters that are legal as file names by the Helix Versioning Engine
  258. can make URL handling difficult. The most basic is the forward slash
  259. &#39;/&#39;.</p>
  260.  
  261. <p>This does <em>NOT</em> guarantee that the string is URL safe! You should
  262. still percent-encode any string as a URL.</p>
  263.  
  264.  
  265.   </div>
  266. </div>
  267. <div class="tags">
  268.   
  269.  
  270. </div><table class="source_code">
  271.   <tr>
  272.     <td>
  273.       <pre class="lines">
  274.  
  275.  
  276. 18
  277. 19
  278. 20
  279. 21
  280. 22
  281. 23
  282. 24
  283. 25
  284. 26</pre>
  285.     </td>
  286.     <td>
  287.       <pre class="code"><span class="info file"># File 'lib/hws_strings.rb', line 18</span>
  288.  
  289. <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_component_encode'>component_encode</span><span class='lparen'>(</span><span class='id identifier rubyid_str'>str</span><span class='comma'>,</span> <span class='label'>illegal_characters:</span> <span class='const'>DEFAULT_ILLEGAL_CHARS</span><span class='rparen'>)</span>
  290.   <span class='id identifier rubyid_str'>str</span><span class='period'>.</span><span class='id identifier rubyid_chars'>chars</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_ch'>ch</span><span class='op'>|</span>
  291.     <span class='kw'>if</span> <span class='id identifier rubyid_illegal_characters'>illegal_characters</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_ch'>ch</span><span class='rparen'>)</span>
  292.       <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>~</span><span class='tstring_end'>&#39;</span></span> <span class='op'>+</span> <span class='id identifier rubyid_ch'>ch</span><span class='period'>.</span><span class='id identifier rubyid_ord'>ord</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='lparen'>(</span><span class='int'>16</span><span class='rparen'>)</span>
  293.     <span class='kw'>else</span>
  294.       <span class='id identifier rubyid_ch'>ch</span>
  295.     <span class='kw'>end</span>
  296.   <span class='kw'>end</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
  297. <span class='kw'>end</span></pre>
  298.     </td>
  299.   </tr>
  300. </table>
  301. </div>
  302.     
  303.   </div>
  304.  
  305. </div>
  306.  
  307.     <div id="footer">
  308.   Generated on Mon Oct 12 22:20:49 2015 by
  309.   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  310.   0.8.7.6 (ruby-2.2.3).
  311. </div>
  312.  
  313.   </body>
  314. </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/HWSStrings.html
#3 15676 tjuricek HWS/NOARCH/2015.1.main/201509092205 10 years ago
#2 15589 tjuricek Update path to test output and update docs. 10 years ago
#1 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