<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Doing::StringQuery
— 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::StringQuery";
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">StringQuery</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::StringQuery
</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/string/query.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Handling of search and regex strings</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="#ignore%3F-instance_method" title="#ignore? (instance method)">#<strong>ignore?</strong> ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Test if line should be ignored.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#ignore_case-instance_method" title="#ignore_case (instance method)">#<strong>ignore_case</strong>(search, case_type) ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Determine whether case should be ignored for string.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#rx%3F-instance_method" title="#rx? (instance method)">#<strong>rx?</strong> ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Determines if receiver is surrounded by slashes or starts with single quote.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#to_bool-instance_method" title="#to_bool (instance method)">#<strong>to_bool</strong> ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns a bool representation of the string.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#to_phrase_query-instance_method" title="#to_phrase_query (instance method)">#<strong>to_phrase_query</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns a phrase query (elastic search) representation of the object as a phrase parser.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#to_query-instance_method" title="#to_query (instance method)">#<strong>to_query</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Returns a query (elastic search) representation of the object as a boolean term parser.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#to_rx-instance_method" title="#to_rx (instance method)">#<strong>to_rx</strong>(distance: nil, case_type: nil) ⇒ Regexp </a>
</span>
<span class="summary_desc"><div class='inline'><p>Convert string to fuzzy regex.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#truthy%3F-instance_method" title="#truthy? (instance method)">#<strong>truthy?</strong> ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'><p>Test string for truthiness (0, "f", "false", "n", "no" all return false, case insensitive, otherwise true).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#wildcard_to_rx-instance_method" title="#wildcard_to_rx (instance method)">#<strong>wildcard_to_rx</strong> ⇒ String </a>
</span>
<span class="summary_desc"><div class='inline'><p>Convert ? and * wildcards to regular expressions.</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="ignore?-instance_method">
#<strong>ignore?</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Test if line should be ignored</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p>line is empty or comment</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="ignore_case-instance_method">
#<strong>ignore_case</strong>(search, case_type) ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Determine whether case should be ignored for string</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>search</span>
<span class='type'></span>
—
<div class='inline'><p>The search string</p>
</div>
</li>
<li>
<span class='name'>case_type</span>
<span class='type'></span>
—
<div class='inline'><p>The case type, :smart,
:sensitive, :ignore</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p>true if case should be ignored</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="rx?-instance_method">
#<strong>rx?</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Determines if receiver is surrounded by slashes or starts with single quote</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p>True if regex, False otherwise.</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="to_bool-instance_method">
#<strong>to_bool</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a bool representation of the string.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p>Bool representation of the object.</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="to_phrase_query-instance_method">
#<strong>to_phrase_query</strong> ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a phrase query (elastic search) representation of the object as a phrase parser.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'><p>Phrase query representation of the object.</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="to_query-instance_method">
#<strong>to_query</strong> ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a query (elastic search) representation of the object as a boolean term parser.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'><p>Query representation of the object.</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="to_rx-instance_method">
#<strong>to_rx</strong>(distance: nil, case_type: nil) ⇒ <tt>Regexp</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Convert string to fuzzy regex. Characters in words
can be separated by up to <em>distance</em> characters in
haystack, spaces indicate unlimited distance.</p>
</div>
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<pre class="example code"><code><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>this word</span><span class='tstring_end'>"</span></span><span class='period'>.</span><span class='id identifier rubyid_to_rx'>to_rx</span><span class='lparen'>(</span><span class='int'>3</span><span class='rparen'>)</span>
<span class='comment'># => /t.{0,3}h.{0,3}i.{0,3}s.{0,3}.*?w.{0,3}o.{0,3}r.{0,3}d/</span></code></pre>
</div>
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>distance</span>
<span class='type'>(<tt>Integer</tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>Allowed distance
between characters</p>
</div>
</li>
<li>
<span class='name'>case_type</span>
<span class='type'></span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>The case type</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Regexp</tt>)</span>
—
<div class='inline'><p>Regex pattern</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="truthy?-instance_method">
#<strong>truthy?</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Test string for truthiness (0, "f", "false", "n", "no" all return false, case insensitive, otherwise true)</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p>String is truthy</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="wildcard_to_rx-instance_method">
#<strong>wildcard_to_rx</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>Convert ? and * wildcards to regular expressions.
Uses \S (non-whitespace) instead of . (any character)</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>Regular expression string</p>
</div>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="footer">
Generated on Fri Mar 10 15:19:58 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>