<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title> Class: Time — Documentation by YARD 0.9.34 </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 = "Time"; 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 (T)</a> » <span class="title">Time</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>Class: Time </h1> <div class="box_info"> <dl> <dt>Inherits:</dt> <dd> <span class="inheritName"><span class='object_link'><a href="Object.html" title="Object (class)">Object</a></span></span> <ul class="fullTree"> <li><span class='object_link'><a href="Object.html" title="Object (class)">Object</a></span></li> <li class="next">Time</li> </ul> <a href="#" class="inheritanceTree">show all</a> </dd> </dl> <dl> <dt>Defined in:</dt> <dd>lib/doing/good.rb<span class="defines">,<br /> lib/doing/time.rb</span> </dd> </dl> </div> <h2>Overview</h2><div class="docstring"> <div class="discussion"> <p>Date helpers</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="#good%3F-instance_method" title="#good? (instance method)">#<strong>good?</strong> ⇒ Boolean </a> </span> <span class="summary_desc"><div class='inline'><p>Tests if object is nil.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#humanize-instance_method" title="#humanize (instance method)">#<strong>humanize</strong>(seconds) ⇒ String </a> </span> <span class="summary_desc"><div class='inline'><p>Format seconds as a natural language string.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#relative_date-instance_method" title="#relative_date (instance method)">#<strong>relative_date</strong> ⇒ String </a> </span> <span class="summary_desc"><div class='inline'><p>Format time as a relative date.</p> </div></span> </li> <li class="public "> <span class="summary_signature"> <a href="#time_ago-instance_method" title="#time_ago (instance method)">#<strong>time_ago</strong> ⇒ String </a> </span> <span class="summary_desc"><div class='inline'><p>Format date as "X hours ago".</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="good?-instance_method"> #<strong>good?</strong> ⇒ <tt>Boolean</tt> </h3><div class="docstring"> <div class="discussion"> <p>Tests if object is nil</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 object is defined and has content</p> </div> </li> </ul> </div> </div> <div class="method_details "> <h3 class="signature " id="humanize-instance_method"> #<strong>humanize</strong>(seconds) ⇒ <tt><span class='object_link'><a href="String.html" title="String (class)">String</a></span></tt> </h3><div class="docstring"> <div class="discussion"> <p>Format seconds as a natural language string</p> </div> </div> <div class="tags"> <p class="tag_title">Parameters:</p> <ul class="param"> <li> <span class='name'>seconds</span> <span class='type'>(<tt>Integer</tt>)</span> — <div class='inline'><p>number of seconds</p> </div> </li> </ul> <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>Date formatted as "X days, X hours, X minutes, X seconds"</p> </div> </li> </ul> </div> </div> <div class="method_details "> <h3 class="signature " id="relative_date-instance_method"> #<strong>relative_date</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>Format time as a relative date. Dates from today get just a time, from the last week get a time and day, from the last year get a month/day/time, and older entries get month/day/year/time</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>formatted date</p> </div> </li> </ul> </div> </div> <div class="method_details "> <h3 class="signature " id="time_ago-instance_method"> #<strong>time_ago</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>Format date as "X hours ago"</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>Formatted date</p> </div> </li> </ul> </div> </div> </div> </div> <div id="footer"> Generated on Thu Aug 17 09:53:01 2023 by <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.34 (ruby-3.2.0). </div> </div> </body> </html>