<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: Doing::ChronifyString
— 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::ChronifyString";
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 (C)</a> »
<span class='title'><span class='object_link'><a href="../Doing.html" title="Doing (module)">Doing</a></span></span>
»
<span class="title">ChronifyString</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::ChronifyString
</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/chronify/string.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Chronify methods for 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="#chronify-instance_method" title="#chronify (instance method)">#<strong>chronify</strong>(**options) ⇒ DateTime </a>
</span>
<span class="summary_desc"><div class='inline'><p>Converts input string into a Time object when input takes on the following formats: - interval format e.g.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#chronify_qty-instance_method" title="#chronify_qty (instance method)">#<strong>chronify_qty</strong> ⇒ Integer </a>
</span>
<span class="summary_desc"><div class='inline'><p>Converts simple strings into seconds that can be added to a Time object.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#expand_date_tags-instance_method" title="#expand_date_tags (instance method)">#<strong>expand_date_tags</strong>(additional_tags = nil) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Convert (chronify) natural language dates within configured date tags (tags whose value is expected to be a date).</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#is_range%3F-instance_method" title="#is_range? (instance method)">#<strong>is_range?</strong> ⇒ Boolean </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#split_date_range-instance_method" title="#split_date_range (instance method)">#<strong>split_date_range</strong> ⇒ Array<DateTime> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Splits a range string and returns an array of DateTime objects as [start, end].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#time_string-instance_method" title="#time_string (instance method)">#<strong>time_string</strong>(format: :dhm) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Convert DD:HH:MM to a natural language string.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#to_seconds-instance_method" title="#to_seconds (instance method)">#<strong>to_seconds</strong> ⇒ Integer </a>
</span>
<span class="summary_desc"><div class='inline'><p>Convert DD:HH:MM to seconds.</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="chronify-instance_method">
#<strong>chronify</strong>(**options) ⇒ <tt>DateTime</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Converts input string into a Time object when input
takes on the following formats:
- interval format e.g. '1d2h30m', '45m'
etc.
- a semantic phrase e.g. 'yesterday
5:30pm'
- a strftime e.g. '2016-03-15 15:32:04
PDT'</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>options</span>
<span class='type'></span>
—
<div class='inline'><p>Additional options</p>
</div>
</li>
</ul>
<p class="tag_title">Options Hash (<tt>**options</tt>):</p>
<ul class="option">
<li>
<span class="name">:future</span>
<span class="type">(<tt>Boolean</tt>)</span>
<span class="default">
</span>
— <div class='inline'><p>assume future date
(default: false)</p>
</div>
</li>
<li>
<span class="name">:guess</span>
<span class="type">(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
<span class="default">
</span>
— <div class='inline'><p>:begin or :end to
assume beginning or end of
arbitrary time range</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>DateTime</tt>)</span>
—
<div class='inline'><p>result</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Errors.html#InvalidTimeExpression-constant" title="Doing::Errors::InvalidTimeExpression (constant)">Errors::InvalidTimeExpression</a></span></tt>)</span>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="chronify_qty-instance_method">
#<strong>chronify_qty</strong> ⇒ <tt>Integer</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Converts simple strings into seconds that can be
added to a Time object</p>
<p>Input string can be HH:MM or XX[dhm]<a href="1d2h30m,%2045m,%201.5d,%201h20m,%20etc.">[XXhm][XXm]</a></p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Integer</tt>)</span>
—
<div class='inline'><p>seconds</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="expand_date_tags-instance_method">
#<strong>expand_date_tags</strong>(additional_tags = nil) ⇒ <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 (chronify) natural language dates
within configured date tags (tags whose value is
expected to be a date). Modifies string in place.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>additional_tags</span>
<span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
<em class="default">(defaults to: <tt>nil</tt>)</em>
—
<div class='inline'><p>An array of
additional tags to
consider date_tags</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="is_range?-instance_method">
#<strong>is_range?</strong> ⇒ <tt>Boolean</tt>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="split_date_range-instance_method">
#<strong>split_date_range</strong> ⇒ <tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span><DateTime></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Splits a range string and returns an array of
DateTime objects as [start, end]. If only one date is
given, end time is nil.</p>
</div>
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<p class="example_title"><div class='inline'><p>Process a natural language date range</p>
</div></p>
<pre class="example code"><code><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>mon 3pm to mon 5pm</span><span class='tstring_end'>"</span></span><span class='period'>.</span><span class='id identifier rubyid_split_date_range'>split_date_range</span></code></pre>
</div>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span><DateTime></tt>)</span>
—
<div class='inline'><p>Start and end dates as
array</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="time_string-instance_method">
#<strong>time_string</strong>(format: :dhm) ⇒ <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 DD:HH:MM to a natural language string</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>format</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>:dhm</tt>)</em>
—
<div class='inline'><p>The format to output (:dhm, :hm, :m, :clock, :natural)</p>
</div>
</li>
</ul>
</div>
</div>
<div class="method_details ">
<h3 class="signature " id="to_seconds-instance_method">
#<strong>to_seconds</strong> ⇒ <tt>Integer</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Convert DD:HH:MM to seconds</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Integer</tt>)</span>
—
<div class='inline'><p>rounded number of seconds</p>
</div>
</li>
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt><span class='object_link'><a href="Errors/DoingRuntimeError.html" title="Doing::Errors::DoingRuntimeError (class)">Errors::DoingRuntimeError</a></span></tt>)</span>
</li>
</ul>
</div>
</div>
</div>
</div>
<div id="footer">
Generated on Sat Mar 11 05:55:28 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>