<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Doing::StringNormalize
— Documentation by YARD 0.9.28
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Doing::StringNormalize";
relpath = '../';
</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 class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (S)</a> »
<span class='title'><span class='object_link'><a href="../Doing.html" title="Doing (module)">Doing</a></span></span>
»
<span class="title">StringNormalize</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: Doing::StringNormalize
</h1>
<div class="box_info">
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/doing/normalize.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>String to symbol conversion</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="#normalize_age-instance_method" title="#normalize_age (instance method)">#<strong>normalize_age</strong>(default = :newest) ⇒ Symbol </a>
</span>
<span class="summary_desc"><div class='inline'><p>Convert an age string to a qualified type.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#normalize_age!-instance_method" title="#normalize_age! (instance method)">#<strong>normalize_age!</strong>(default = :newest) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#normalize_bool-instance_method" title="#normalize_bool (instance method)">#<strong>normalize_bool</strong>(default = :and) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Convert a boolean string to a symbol.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#normalize_bool!-instance_method" title="#normalize_bool! (instance method)">#<strong>normalize_bool!</strong>(default = :and) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#normalize_case-instance_method" title="#normalize_case (instance method)">#<strong>normalize_case</strong>(default = :smart) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Convert a case sensitivity string to a symbol.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#normalize_case!-instance_method" title="#normalize_case! (instance method)">#<strong>normalize_case!</strong>(default = :smart) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#normalize_change_type-instance_method" title="#normalize_change_type (instance method)">#<strong>normalize_change_type</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#normalize_list_style-instance_method" title="#normalize_list_style (instance method)">#<strong>normalize_list_style</strong>(default = :space) ⇒ Symbol </a>
</span>
<span class="summary_desc"><div class='inline'><p>Normalize list output style.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#normalize_matching-instance_method" title="#normalize_matching (instance method)">#<strong>normalize_matching</strong>(default = :pattern) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Convert a matching configuration string to a symbol.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#normalize_matching!-instance_method" title="#normalize_matching! (instance method)">#<strong>normalize_matching!</strong>(default = :pattern) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#normalize_order-instance_method" title="#normalize_order (instance method)">#<strong>normalize_order</strong>(default = :asc) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#normalize_order!-instance_method" title="#normalize_order! (instance method)">#<strong>normalize_order!</strong>(default = :asc) ⇒ Symbol </a>
</span>
<span class="summary_desc"><div class='inline'><p>Convert a sort order string to a qualified type.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#normalize_tag_sort-instance_method" title="#normalize_tag_sort (instance method)">#<strong>normalize_tag_sort</strong>(default = :name) ⇒ Symbol </a>
</span>
<span class="summary_desc"><div class='inline'><p>Convert tag sort string to a qualified type.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#normalize_tag_sort!-instance_method" title="#normalize_tag_sort! (instance method)">#<strong>normalize_tag_sort!</strong>(default = :name) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#normalize_trigger-instance_method" title="#normalize_trigger (instance method)">#<strong>normalize_trigger</strong> ⇒ String </a>
</span>
<span class="summary_desc"><div class='inline'><p>Adds ?: to any parentheticals in a regular expression to avoid match groups.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#normalize_trigger!-instance_method" title="#normalize_trigger! (instance method)">#<strong>normalize_trigger!</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'></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="normalize_age-instance_method">
#<strong>normalize_age</strong>(default = :newest) ⇒ <tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Convert an age string to a qualified type</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="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
—
<div class='inline'><p>:oldest or :newest</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="normalize_age!-instance_method">
#<strong>normalize_age!</strong>(default = :newest) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="#normalize_age-instance_method" title="Doing::StringNormalize#normalize_age (method)">#normalize_age</a></span></li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="normalize_bool-instance_method">
#<strong>normalize_bool</strong>(default = :and) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Convert a boolean string to a symbol</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'><p>Symbol :and, :or, or :not</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="normalize_bool!-instance_method">
#<strong>normalize_bool!</strong>(default = :and) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="#normalize_bool-instance_method" title="Doing::StringNormalize#normalize_bool (method)">#normalize_bool</a></span></li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="normalize_case-instance_method">
#<strong>normalize_case</strong>(default = :smart) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Convert a case sensitivity string to a symbol</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'><p>Symbol :smart, :sensitive, :ignore</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="normalize_case!-instance_method">
#<strong>normalize_case!</strong>(default = :smart) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="#normalize_case-instance_method" title="Doing::StringNormalize#normalize_case (method)">#normalize_case</a></span></li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="normalize_change_type-instance_method">
#<strong>normalize_change_type</strong> ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3>
</div>
<div class="method_details ">
<h3 class="signature " id="normalize_list_style-instance_method">
#<strong>normalize_list_style</strong>(default = :space) ⇒ <tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Normalize list output style</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>default</span>
<span class='type'></span>
<em class="default">(defaults to: <tt>:space</tt>)</em>
—
<div class='inline'><p>The default</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
—
<div class='inline'><p>:comma, :column, :tab, :space</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="normalize_matching-instance_method">
#<strong>normalize_matching</strong>(default = :pattern) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Convert a matching configuration string to a symbol</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>default</span>
<span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
<em class="default">(defaults to: <tt>:pattern</tt>)</em>
—
<div class='inline'><p>the default matching
type to return if the string
doesn't match a known symbol</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'><p>Symbol :fuzzy, :pattern, :exact</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="normalize_matching!-instance_method">
#<strong>normalize_matching!</strong>(default = :pattern) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="#normalize_matching-instance_method" title="Doing::StringNormalize#normalize_matching (method)">#normalize_matching</a></span></li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="normalize_order-instance_method">
#<strong>normalize_order</strong>(default = :asc) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3>
</div>
<div class="method_details ">
<h3 class="signature " id="normalize_order!-instance_method">
#<strong>normalize_order!</strong>(default = :asc) ⇒ <tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Convert a sort order string to a qualified type</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="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
—
<div class='inline'><p>:asc or :desc</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="normalize_tag_sort-instance_method">
#<strong>normalize_tag_sort</strong>(default = :name) ⇒ <tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Convert tag sort string to a qualified type</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="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
—
<div class='inline'><p>:name or :time</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="normalize_tag_sort!-instance_method">
#<strong>normalize_tag_sort!</strong>(default = :name) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="#normalize_tag_sort-instance_method" title="Doing::StringNormalize#normalize_tag_sort (method)">#normalize_tag_sort</a></span></li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="normalize_trigger-instance_method">
#<strong>normalize_trigger</strong> ⇒ <tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Adds ?: to any parentheticals in a regular expression
to avoid match groups</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="../String.html" title="String (class)">String</a></span></tt>)</span>
—
<div class='inline'><p>modified regular expression</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="normalize_trigger!-instance_method">
#<strong>normalize_trigger!</strong> ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="#normalize_trigger-instance_method" title="Doing::StringNormalize#normalize_trigger (method)">#normalize_trigger</a></span></li>
</ul>
</div>
</div>
</div>
</div>
<div id="footer">
Generated on Sat Mar 11 06:08:17 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.28 (ruby-3.0.1).
</div>
</div>
</body>
</html>