mirror of
https://github.com/mistergibson/gxg-framework.git
synced 2026-08-15 03:46:00 -07:00
266 lines
13 KiB
HTML
266 lines
13 KiB
HTML
<!DOCTYPE html>
|
|
|
|
<html>
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
|
|
<title>module GxG::Units - RDoc Documentation</title>
|
|
|
|
<script type="text/javascript">
|
|
var rdoc_rel_prefix = "../";
|
|
var index_rel_prefix = "../";
|
|
</script>
|
|
|
|
<script src="../js/navigation.js" defer></script>
|
|
<script src="../js/search.js" defer></script>
|
|
<script src="../js/search_index.js" defer></script>
|
|
<script src="../js/searcher.js" defer></script>
|
|
<script src="../js/darkfish.js" defer></script>
|
|
|
|
<link href="../css/fonts.css" rel="stylesheet">
|
|
<link href="../css/rdoc.css" rel="stylesheet">
|
|
|
|
|
|
|
|
<body id="top" role="document" class="module">
|
|
<nav role="navigation">
|
|
<div id="project-navigation">
|
|
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
|
|
<h2>
|
|
<a href="../index.html" rel="home">Home</a>
|
|
</h2>
|
|
|
|
<div id="table-of-contents-navigation">
|
|
<a href="../table_of_contents.html#pages">Pages</a>
|
|
<a href="../table_of_contents.html#classes">Classes</a>
|
|
<a href="../table_of_contents.html#methods">Methods</a>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="search-section" role="search" class="project-section initially-hidden">
|
|
<form action="#" method="get" accept-charset="utf-8">
|
|
<div id="search-field-wrapper">
|
|
<input id="search-field" role="combobox" aria-label="Search"
|
|
aria-autocomplete="list" aria-controls="search-results"
|
|
type="text" name="search" placeholder="Search" spellcheck="false"
|
|
title="Type to search, Up and Down to navigate, Enter to load">
|
|
</div>
|
|
|
|
<ul id="search-results" aria-label="Search Results"
|
|
aria-busy="false" aria-expanded="false"
|
|
aria-atomic="false" class="initially-hidden"></ul>
|
|
</form>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div id="class-metadata">
|
|
|
|
|
|
|
|
|
|
<!-- Method Quickref -->
|
|
<div id="method-list-section" class="nav-section">
|
|
<h3>Methods</h3>
|
|
|
|
<ul class="link-list" role="directory">
|
|
|
|
<li ><a href="#method-c-interpret_units">::interpret_units</a>
|
|
|
|
<li ><a href="#method-c-refresh_units_registry">::refresh_units_registry</a>
|
|
|
|
<li ><a href="#method-c-unit_interpreters">::unit_interpreters</a>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</nav>
|
|
|
|
<main role="main" aria-labelledby="module-GxG::Units">
|
|
<h1 id="module-GxG::Units" class="module">
|
|
module GxG::Units
|
|
</h1>
|
|
|
|
<section class="description">
|
|
|
|
</section>
|
|
|
|
|
|
<section id="5Buntitled-5D" class="documentation-section">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
|
<header>
|
|
<h3>Public Class Methods</h3>
|
|
</header>
|
|
|
|
|
|
<div id="method-c-interpret_units" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">interpret_units</span><span
|
|
class="method-args">(params={})</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="interpret_units-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_units.rb, line 40</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">interpret_units</span>(<span class="ruby-identifier">params</span>={})
|
|
<span class="ruby-comment"># {:text => quanta,:categories => categories,:locale => locale}</span>
|
|
<span class="ruby-identifier">quanta_string</span> = (<span class="ruby-identifier">params</span>[<span class="ruby-value">:text</span>] <span class="ruby-operator">||</span> <span class="ruby-string">""</span>)
|
|
<span class="ruby-identifier">categories</span> = (<span class="ruby-identifier">params</span>[<span class="ruby-value">:categories</span>] <span class="ruby-operator">||</span> <span class="ruby-value">:any</span>)
|
|
<span class="ruby-identifier">locale</span> = (<span class="ruby-identifier">params</span>[<span class="ruby-value">:locale</span>] <span class="ruby-operator">||</span> <span class="ruby-value">:en_US</span>)
|
|
<span class="ruby-identifier">numeric_base</span> = (<span class="ruby-identifier">params</span>[<span class="ruby-value">:base</span>] <span class="ruby-operator">||</span> <span class="ruby-value">10</span>)
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">categories</span> <span class="ruby-operator">==</span> <span class="ruby-value">:any</span>
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">categories</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Array</span>)
|
|
<span class="ruby-identifier">categories</span> = [(<span class="ruby-identifier">categories</span>)]
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">results</span> = []
|
|
<span class="ruby-identifier">@@interpreters</span>.<span class="ruby-identifier">to_enum</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">interpreter</span><span class="ruby-operator">|</span>
|
|
<span class="ruby-identifier">entry</span> = <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">categories</span> <span class="ruby-operator">==</span> <span class="ruby-value">:any</span>
|
|
<span class="ruby-identifier">entry</span> = <span class="ruby-identifier">interpreter</span><span class="ruby-operator">::</span><span class="ruby-identifier">interpret</span>(<span class="ruby-identifier">quanta_string</span>.<span class="ruby-identifier">to_s</span>,<span class="ruby-identifier">locale</span>,<span class="ruby-identifier">numeric_base</span>)
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">categories</span>.<span class="ruby-identifier">to_enum</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">category</span><span class="ruby-operator">|</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">interpreter</span><span class="ruby-operator">::</span><span class="ruby-identifier">categories</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">category</span>)
|
|
<span class="ruby-identifier">entry</span> = <span class="ruby-identifier">interpreter</span>.<span class="ruby-identifier">interpret</span>(<span class="ruby-identifier">quanta_string</span>.<span class="ruby-identifier">to_s</span>,<span class="ruby-identifier">locale</span>,<span class="ruby-identifier">numeric_base</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">entry</span>
|
|
<span class="ruby-identifier">results</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">entry</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
{<span class="ruby-value">:result</span> <span class="ruby-operator">=></span> <span class="ruby-identifier">results</span>}
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-c-refresh_units_registry" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">refresh_units_registry</span><span
|
|
class="method-args">()</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="refresh_units_registry-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_units.rb, line 35</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">refresh_units_registry</span>()
|
|
<span class="ruby-comment"># SOMEDAY: Thread-safety?</span>
|
|
<span class="ruby-identifier">@@interpreters</span> = <span class="ruby-keyword">self</span>.<span class="ruby-identifier">unit_interpreters</span>()
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-c-unit_interpreters" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">unit_interpreters</span><span
|
|
class="method-args">(categories=:any)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
<p>this module is used for interpreting text into denominations and multipliers., and general support for various units of measure</p>
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="unit_interpreters-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_units.rb, line 10</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">unit_interpreters</span>(<span class="ruby-identifier">categories</span>=<span class="ruby-value">:any</span>)
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">categories</span> <span class="ruby-operator">==</span> <span class="ruby-value">:any</span>
|
|
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">categories</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Array</span>)
|
|
<span class="ruby-identifier">categories</span> = [(<span class="ruby-identifier">categories</span>)]
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">unit_list</span> = []
|
|
<span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Units</span>.<span class="ruby-identifier">constants</span>.<span class="ruby-identifier">to_enum</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">unit_handler</span><span class="ruby-operator">|</span>
|
|
<span class="ruby-identifier">unit_handler</span> = <span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Units</span>.<span class="ruby-identifier">const_get</span>(<span class="ruby-identifier">unit_handler</span>)
|
|
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">unit_handler</span>.<span class="ruby-identifier">is_any?</span>([<span class="ruby-constant">Class</span>, <span class="ruby-constant">Module</span>]) <span class="ruby-operator">&&</span> <span class="ruby-identifier">unit_handler</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:interpret</span>) <span class="ruby-operator">&&</span> <span class="ruby-identifier">unit_handler</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:categories</span>))
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">categories</span> <span class="ruby-operator">==</span> <span class="ruby-value">:any</span>
|
|
<span class="ruby-identifier">unit_list</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">unit_handler</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">categories</span>.<span class="ruby-identifier">to_enum</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">category</span><span class="ruby-operator">|</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">unit_handler</span><span class="ruby-operator">::</span><span class="ruby-identifier">categories</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">category</span>)
|
|
<span class="ruby-identifier">unit_list</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">unit_handler</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-comment">#</span>
|
|
<span class="ruby-identifier">unit_list</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</section>
|
|
|
|
</section>
|
|
</main>
|
|
|
|
|
|
<footer id="validator-badges" role="contentinfo">
|
|
<p><a href="https://validator.w3.org/check/referer">Validate</a>
|
|
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.1.2.
|
|
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
</footer>
|
|
|