<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Module: Lazier::String
— Documentation by YARD 0.8.7.3
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
hasFrames = window.top.frames.main ? true : false;
relpath = '../';
framesUrl = "../frames.html#!" + escape(window.location.href);
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div id="header">
<div id="menu">
<a href="../_index.html">Index (S)</a> »
<span class='title'><span class='object_link'><a href="../Lazier.html" title="Lazier (module)">Lazier</a></span></span>
»
<span class="title">String</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
Class List
</a>
<a class="full_list_link" id="method_list_link"
href="../method_list.html">
Method List
</a>
<a class="full_list_link" id="file_list_link"
href="../file_list.html">
File List
</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Module: Lazier::String
</h1>
<dl class="box">
<dt class="r1">Extended by:</dt>
<dd class="r1">ActiveSupport::Concern</dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/lazier/string.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Extensions for the String class.</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#ensure_valid_utf8-instance_method" title="#ensure_valid_utf8 (instance method)">- (String) <strong>ensure_valid_utf8</strong>(replacement = "") </a>
</span>
<span class="summary_desc"><div class='inline'><p>Makes sure the string only contains valid UTF-8 sequences.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#remove_accents-instance_method" title="#remove_accents (instance method)">- (Object) <strong>remove_accents</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Removes accents from the string, normalizing to the normal letter.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#replace_ampersands-instance_method" title="#replace_ampersands (instance method)">- (String) <strong>replace_ampersands</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns the string with all <code>&amp;</code> replaced with <code>&</code>.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#split_tokens-instance_method" title="#split_tokens (instance method)">- (Array) <strong>split_tokens</strong>(no_blanks = true, strip = true, uniq = false, pattern = /\s*,\s*/) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Splits a string containing tokens using a specified pattern and applying some sanitizations.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#untitleize-instance_method" title="#untitleize (instance method)">- (String) <strong>untitleize</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns the tagged version of a string.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#value-instance_method" title="#value (instance method)">- (String) <strong>value</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns the string itself for use in form helpers.</p>
</div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="ensure_valid_utf8-instance_method">
- (<tt><span class='object_link'><a href="" title="Lazier::String (module)">String</a></span></tt>) <strong>ensure_valid_utf8</strong>(replacement = "")
</h3><div class="docstring">
<div class="discussion">
<p>Makes sure the string only contains valid UTF-8 sequences.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>replacement</span>
<span class='type'>(<tt><span class='object_link'><a href="" title="Lazier::String (module)">String</a></span></tt>)</span>
<em class="default">(defaults to: <tt>""</tt>)</em>
—
<div class='inline'><p>The string to use to replace invalid sequences.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="" title="Lazier::String (module)">String</a></span></tt>)</span>
—
<div class='inline'><p>The string with any invalid UTF-8 sequences replaced.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
28
29
30
31</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/lazier/string.rb', line 28</span>
<span class='kw'>def</span> <span class='id identifier rubyid_ensure_valid_utf8'>ensure_valid_utf8</span><span class='lparen'>(</span><span class='id identifier rubyid_replacement'>replacement</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='comment'># This odd line is because if need to specify a different encoding (without losing infos) to replace invalid bytes and then we go back to utf-8
</span> <span class='op'>!</span><span class='kw'>defined?</span><span class='lparen'>(</span><span class='const'>JRUBY_VERSION</span><span class='rparen'>)</span> <span class='op'>?</span> <span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>utf-16</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>invalid:</span> <span class='symbol'>:replace</span><span class='comma'>,</span> <span class='label'>undef:</span> <span class='symbol'>:replace</span><span class='comma'>,</span> <span class='label'>replace:</span> <span class='id identifier rubyid_replacement'>replacement</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>utf-8</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='op'>:</span> <span class='id identifier rubyid_raise'>raise</span><span class='lparen'>(</span><span class='const'>RuntimeError</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Sorry, Lazier::String#ensure_valid_utf8 is not available on JRuby.</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="remove_accents-instance_method">
- (<tt><span class='object_link'><a href="Object.html" title="Lazier::Object (module)">Object</a></span></tt>) <strong>remove_accents</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Removes accents from the string, normalizing to the normal letter.</p>
<p><code>ruby
"èòàù".remove_accents
# => "eoau"
</code></p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'><p>The string with all accents removed.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
20
21
22</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/lazier/string.rb', line 20</span>
<span class='kw'>def</span> <span class='id identifier rubyid_remove_accents'>remove_accents</span>
<span class='id identifier rubyid_silence_warnings'>silence_warnings</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_mb_chars'>mb_chars</span><span class='period'>.</span><span class='id identifier rubyid_normalize'>normalize</span><span class='lparen'>(</span><span class='symbol'>:kd</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>[^\x00-\x7F]</span><span class='regexp_end'>/n</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='rbrace'>}</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="replace_ampersands-instance_method">
- (<tt><span class='object_link'><a href="" title="Lazier::String (module)">String</a></span></tt>) <strong>replace_ampersands</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the string with all <code>&amp;</code> replaced with <code>&</code>.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="" title="Lazier::String (module)">String</a></span></tt>)</span>
—
<div class='inline'><p>The string with all <code>&amp;</code> replaced with <code>&</code>.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
50
51
52</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/lazier/string.rb', line 50</span>
<span class='kw'>def</span> <span class='id identifier rubyid_replace_ampersands'>replace_ampersands</span>
<span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>&amp;(\S+);</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>&\\1;</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="split_tokens-instance_method">
- (<tt>Array</tt>) <strong>split_tokens</strong>(no_blanks = true, strip = true, uniq = false, pattern = /\s*,\s*/)
</h3><div class="docstring">
<div class="discussion">
<p>Splits a string containing tokens using a specified pattern and applying some sanitizations.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>no_blanks</span>
<span class='type'>(<tt><span class='object_link'><a href="Boolean.html" title="Lazier::Boolean (module)">Boolean</a></span></tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
—
<div class='inline'><p>If filter out blank tokens.</p>
</div>
</li>
<li>
<span class='name'>strip</span>
<span class='type'>(<tt><span class='object_link'><a href="Boolean.html" title="Lazier::Boolean (module)">Boolean</a></span></tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
—
<div class='inline'><p>If strip single tokens.</p>
</div>
</li>
<li>
<span class='name'>uniq</span>
<span class='type'>(<tt><span class='object_link'><a href="Boolean.html" title="Lazier::Boolean (module)">Boolean</a></span></tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
—
<div class='inline'><p>If return uniques elements.</p>
</div>
</li>
<li>
<span class='name'>pattern</span>
<span class='type'>(<tt><span class='object_link'><a href="" title="Lazier::String (module)">String</a></span>|Regexp</tt>)</span>
<em class="default">(defaults to: <tt>/\s*,\s*/</tt>)</em>
—
<div class='inline'><p>The pattern to use.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array</tt>)</span>
—
<div class='inline'><p>An array of tokens.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
68
69
70
71
72
73
74</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/lazier/string.rb', line 68</span>
<span class='kw'>def</span> <span class='id identifier rubyid_split_tokens'>split_tokens</span><span class='lparen'>(</span><span class='id identifier rubyid_no_blanks'>no_blanks</span> <span class='op'>=</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='id identifier rubyid_strip'>strip</span> <span class='op'>=</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='id identifier rubyid_uniq'>uniq</span> <span class='op'>=</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='id identifier rubyid_pattern'>pattern</span> <span class='op'>=</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\s*,\s*</span><span class='regexp_end'>/</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_rv'>rv</span> <span class='op'>=</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='id identifier rubyid_pattern'>pattern</span><span class='rparen'>)</span>
<span class='id identifier rubyid_rv'>rv</span><span class='period'>.</span><span class='id identifier rubyid_map!'>map!</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:strip</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_strip'>strip</span>
<span class='id identifier rubyid_rv'>rv</span><span class='period'>.</span><span class='id identifier rubyid_select!'>select!</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:present?</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_no_blanks'>no_blanks</span>
<span class='id identifier rubyid_rv'>rv</span><span class='period'>.</span><span class='id identifier rubyid_uniq!'>uniq!</span> <span class='kw'>if</span> <span class='id identifier rubyid_uniq'>uniq</span>
<span class='id identifier rubyid_rv'>rv</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="untitleize-instance_method">
- (<tt><span class='object_link'><a href="" title="Lazier::String (module)">String</a></span></tt>) <strong>untitleize</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the tagged version of a string.</p>
<p>The string is downcased and spaces are substituted with <code>-</code>.</p>
<p><code>ruby
"ABC cde".untitleize
# => "abc-cde"
</code></p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="" title="Lazier::String (module)">String</a></span></tt>)</span>
—
<div class='inline'><p>The untitleized version of the string.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
43
44
45</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/lazier/string.rb', line 43</span>
<span class='kw'>def</span> <span class='id identifier rubyid_untitleize'>untitleize</span>
<span class='id identifier rubyid_downcase'>downcase</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'> </span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>-</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="value-instance_method">
- (<tt><span class='object_link'><a href="" title="Lazier::String (module)">String</a></span></tt>) <strong>value</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the string itself for use in form helpers.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="" title="Lazier::String (module)">String</a></span></tt>)</span>
—
<div class='inline'><p>The string itself.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
57
58
59</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/lazier/string.rb', line 57</span>
<span class='kw'>def</span> <span class='id identifier rubyid_value'>value</span>
<span class='kw'>self</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Feb 23 15:47:03 2014 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.3 (ruby-2.1.0).
</div>
</body>
</html>