mirror of
https://github.com/mistergibson/gxg-framework.git
synced 2026-08-15 03:46:00 -07:00
629 lines
27 KiB
HTML
629 lines
27 KiB
HTML
<!DOCTYPE html>
|
|
|
|
<html>
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
|
|
<title>module GxG - 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-apportioned_ranges">::apportioned_ranges</a>
|
|
|
|
<li ><a href="#method-c-passes_needed">::passes_needed</a>
|
|
|
|
<li ><a href="#method-c-reconstitute">::reconstitute</a>
|
|
|
|
<li ><a href="#method-c-shutdown">::shutdown</a>
|
|
|
|
<li ><a href="#method-c-sql_statement-3F">::sql_statement?</a>
|
|
|
|
<li ><a href="#method-c-uuid_generate">::uuid_generate</a>
|
|
|
|
<li ><a href="#method-c-valid_domain_name-3F">::valid_domain_name?</a>
|
|
|
|
<li ><a href="#method-c-valid_uuid-3F">::valid_uuid?</a>
|
|
|
|
<li ><a href="#method-i-find_local">#find_local</a>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</nav>
|
|
|
|
<main role="main" aria-labelledby="module-GxG">
|
|
<h1 id="module-GxG" class="module">
|
|
module GxG
|
|
</h1>
|
|
|
|
<section class="description">
|
|
|
|
<pre>---------------------------------------------------------------------------------------------------------------------</pre>
|
|
|
|
<p>Various preliminary patches to dependencies:</p>
|
|
<hr>
|
|
|
|
<p>Various preliminary patches to standard classes: <none></p>
|
|
<hr>
|
|
|
|
<p>main module declaration:</p>
|
|
<hr>
|
|
|
|
<p>Set <a href="GxG.html"><code>GxG</code></a> <a href="GxG/Version.html"><code>Version</code></a> and instantiate <a href="GxG.html#SYSTEM"><code>GxG::SYSTEM</code></a> object:</p>
|
|
|
|
<p>First attempt at object serialization/reconstitution:</p>
|
|
|
|
<p>determine the arch, platform with version, and ruby implementation with version store this in <a href="GxG.html#BOOTSTRAP"><code>GxG::BOOTSTRAP</code></a></p>
|
|
|
|
<p>To overcome load-order issues:</p>
|
|
|
|
<p><a href="GxG.html"><code>GxG</code></a> <a href="GxG/Communications.html"><code>Communications</code></a> Layer</p>
|
|
|
|
<p>PeristedArray Code:</p>
|
|
|
|
<p>PersistedHash Code:</p>
|
|
<hr>
|
|
|
|
<p>Various data element classes:</p>
|
|
<hr>
|
|
|
|
<p><a href="GxG.html"><code>GxG</code></a> <a href="GxG/Engine.html"><code>Engine</code></a> interface: rational memory management, and quota supports</p>
|
|
<hr>
|
|
|
|
<p>Preliminary <a href="GxG/Entity.html"><code>Entity</code></a> supports</p>
|
|
|
|
<p><a href="GxG/IO.html"><code>IO</code></a> <a href="GxG/Support.html"><code>Support</code></a> Library Module & <a href="GxG/IO.html"><code>IO</code></a> Classes ############################################</p>
|
|
|
|
<p>Auto-Transcoding <a href="GxG/Support.html"><code>Support</code></a> Library Module ############################################</p>
|
|
<hr>
|
|
|
|
<p><a href="GxG/Units.html"><code>Units</code></a> and support element classes:</p>
|
|
|
|
<p>gxg_ipc is there to pick the bones, but will be discarded : use this file.</p>
|
|
|
|
<p>GxG:</p>
|
|
|
|
<p><a href="GxG/Networking.html"><code>Networking</code></a> Section of <a href="GxG.html"><code>GxG</code></a></p>
|
|
|
|
</section>
|
|
|
|
|
|
<section id="5Buntitled-5D" class="documentation-section">
|
|
|
|
|
|
|
|
|
|
|
|
<section class="constants-list">
|
|
<header>
|
|
<h3>Constants</h3>
|
|
</header>
|
|
<dl>
|
|
|
|
<dt id="BOOTSTRAP">BOOTSTRAP
|
|
|
|
<dd><p>cleanup</p>
|
|
|
|
<p>return final result</p>
|
|
|
|
|
|
<dt id="BRIDGES">BRIDGES
|
|
|
|
<dd>
|
|
|
|
|
|
<dt id="BRIDGES_AVAILABLE">BRIDGES_AVAILABLE
|
|
|
|
<dd>
|
|
|
|
|
|
<dt id="DB">DB
|
|
|
|
<dd>
|
|
|
|
|
|
<dt id="LOG">LOG
|
|
|
|
<dd><p><a href="GxG.html#LOG"><code>LOG</code></a> = $LOG</p>
|
|
|
|
|
|
<dt id="RUBY_ENGINE">RUBY_ENGINE
|
|
|
|
<dd>
|
|
|
|
|
|
<dt id="SYSTEM">SYSTEM
|
|
|
|
<dd>
|
|
|
|
|
|
<dt id="VERSION">VERSION
|
|
|
|
<dd><p>setup constants, dispose of <a href="GxG.html#BOOTSTRAP"><code>BOOTSTRAP</code></a> data.</p>
|
|
|
|
|
|
<dt id="VFS">VFS
|
|
|
|
<dd>
|
|
|
|
|
|
</dl>
|
|
</section>
|
|
|
|
|
|
|
|
|
|
|
|
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
|
|
<header>
|
|
<h3>Public Class Methods</h3>
|
|
</header>
|
|
|
|
|
|
<div id="method-c-apportioned_ranges" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">apportioned_ranges</span><span
|
|
class="method-args">(how_much_data=0, container_limit=0, original_offset=0)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="apportioned_ranges-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg.rb, line 530</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">apportioned_ranges</span>(<span class="ruby-identifier">how_much_data</span>=<span class="ruby-value">0</span>, <span class="ruby-identifier">container_limit</span>=<span class="ruby-value">0</span>, <span class="ruby-identifier">original_offset</span>=<span class="ruby-value">0</span>)
|
|
<span class="ruby-identifier">result</span> = []
|
|
<span class="ruby-identifier">the_count</span> = <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-identifier">passes_needed</span>(<span class="ruby-identifier">how_much_data</span>, <span class="ruby-identifier">container_limit</span>)
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">the_count</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
|
<span class="ruby-identifier">offset</span> = <span class="ruby-identifier">original_offset</span>
|
|
<span class="ruby-identifier">the_count</span>.<span class="ruby-identifier">times</span> <span class="ruby-keyword">do</span>
|
|
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">offset</span> <span class="ruby-operator">+</span> (<span class="ruby-identifier">container_limit</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>)) <span class="ruby-operator"><=</span> (<span class="ruby-identifier">how_much_data</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>)
|
|
<span class="ruby-identifier">end_point</span> = (<span class="ruby-identifier">offset</span> <span class="ruby-operator">+</span> (<span class="ruby-identifier">container_limit</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>))
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">end_point</span> = (<span class="ruby-identifier">how_much_data</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">result</span> <span class="ruby-operator"><<</span> ((<span class="ruby-identifier">offset</span>)<span class="ruby-operator">..</span>(<span class="ruby-identifier">end_point</span>))
|
|
<span class="ruby-identifier">offset</span> = (<span class="ruby-identifier">end_point</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">result</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-c-passes_needed" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">passes_needed</span><span
|
|
class="method-args">(size_used=0, container_limit=0)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
<p>Generic toolbox of methods</p>
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="passes_needed-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg.rb, line 516</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">passes_needed</span>(<span class="ruby-identifier">size_used</span>=<span class="ruby-value">0</span>, <span class="ruby-identifier">container_limit</span>=<span class="ruby-value">0</span>)
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">size_used</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span> <span class="ruby-keyword">and</span> <span class="ruby-identifier">container_limit</span> <span class="ruby-operator">></span> <span class="ruby-value">0</span>
|
|
<span class="ruby-identifier">needed_raw</span> = <span class="ruby-identifier">size_used</span>.<span class="ruby-identifier">to_f</span> <span class="ruby-operator">/</span> <span class="ruby-identifier">container_limit</span>.<span class="ruby-identifier">to_f</span>
|
|
<span class="ruby-identifier">overhang</span> = <span class="ruby-identifier">needed_raw</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">needed_raw</span>.<span class="ruby-identifier">to_i</span>.<span class="ruby-identifier">to_f</span>
|
|
<span class="ruby-identifier">needed_raw</span> = <span class="ruby-identifier">needed_raw</span>.<span class="ruby-identifier">to_i</span>.<span class="ruby-identifier">to_f</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">overhang</span> <span class="ruby-operator">></span> <span class="ruby-value">0.0</span>
|
|
<span class="ruby-identifier">needed_raw</span> <span class="ruby-operator">+=</span> <span class="ruby-value">1.0</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">needed_raw</span>.<span class="ruby-identifier">to_i</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-value">0</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-c-reconstitute" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">reconstitute</span><span
|
|
class="method-args">(raw_data="")</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="reconstitute-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg.rb, line 472</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">reconstitute</span>(<span class="ruby-identifier">raw_data</span>=<span class="ruby-string">""</span>)
|
|
<span class="ruby-comment"># See: http://stackoverflow.com/questions/5758464/ruby-how-do-i-check-if-a-class-is-defined</span>
|
|
<span class="ruby-comment">#</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">raw_data</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">raw_data</span>.<span class="ruby-identifier">serialized?</span>()
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">nil</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">raw_data</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-string">"marshal:"</span>)
|
|
<span class="ruby-keyword">begin</span>
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Marshal</span>.<span class="ruby-identifier">load</span>(<span class="ruby-identifier">raw_data</span>[(<span class="ruby-value">8</span><span class="ruby-operator">..</span><span class="ruby-value">-1</span>)].<span class="ruby-identifier">decode64</span>())
|
|
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span>
|
|
<span class="ruby-comment"># Question : what to do here.</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">raw_data</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-string">"structure:"</span>)
|
|
<span class="ruby-identifier">data</span> = <span class="ruby-operator">::</span><span class="ruby-constant">Marshal</span>.<span class="ruby-identifier">load</span>(<span class="ruby-identifier">raw_data</span>[(<span class="ruby-value">10</span><span class="ruby-operator">..</span><span class="ruby-value">-1</span>)].<span class="ruby-identifier">decode64</span>())
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">data</span>.<span class="ruby-identifier">is_any?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">Array</span>, <span class="ruby-operator">::</span><span class="ruby-constant">Hash</span>, <span class="ruby-operator">::</span><span class="ruby-constant">Set</span>, <span class="ruby-operator">::</span><span class="ruby-constant">Struct</span>)
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-identifier">data</span>.<span class="ruby-identifier">process</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">entry</span>, <span class="ruby-identifier">selector</span><span class="ruby-operator">|</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>)
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">entry</span>.<span class="ruby-identifier">serialized?</span>()
|
|
<span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-identifier">reconstitute</span>(<span class="ruby-identifier">entry</span>)
|
|
<span class="ruby-comment"># entry.unserialize()</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">entry</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">entry</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Exception</span>, <span class="ruby-string">"unrecognized serialization format"</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-identifier">raw_data</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">result</span> = <span class="ruby-identifier">raw_data</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">result</span>
|
|
<span class="ruby-comment">#</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-c-shutdown" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">shutdown</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="shutdown-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg.rb, line 465</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">shutdown</span>()
|
|
<span class="ruby-identifier">$Dispatcher</span>.<span class="ruby-identifier">shutdown</span>()
|
|
<span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Networking</span><span class="ruby-operator">::</span><span class="ruby-constant">ZMQ</span><span class="ruby-operator">::</span><span class="ruby-identifier">zmq_default_context</span>.<span class="ruby-identifier">terminate</span>()
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-c-sql_statement-3F" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">sql_statement?</span><span
|
|
class="method-args">(the_string)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="sql_statement-3F-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg.rb, line 569</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">sql_statement?</span>(<span class="ruby-identifier">the_string</span>)
|
|
<span class="ruby-comment"># See: https://larrysteinle.com/2011/02/20/use-regular-expressions-to-detect-sql-code-injection/</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-regexp">/('(''|[^'])*')|(;)|(\\x08(ALTER|CREATE|DELETE|DROP|EXEC(UTE){0,1}|INSERT( +INTO){0,1}|MERGE|SELECT|UPDATE|UNION( +ALL){0,1})\\x08)/</span>.<span class="ruby-identifier">match</span>(<span class="ruby-identifier">the_string</span>)
|
|
<span class="ruby-keyword">true</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-keyword">false</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-c-uuid_generate" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">uuid_generate</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="uuid_generate-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg.rb, line 91</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">uuid_generate</span>()
|
|
<span class="ruby-operator">::</span><span class="ruby-constant">SecureRandom</span><span class="ruby-operator">::</span><span class="ruby-identifier">uuid</span>.<span class="ruby-identifier">to_s</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-c-valid_domain_name-3F" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">valid_domain_name?</span><span
|
|
class="method-args">(the_string)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="valid_domain_name-3F-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg.rb, line 578</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">valid_domain_name?</span>(<span class="ruby-identifier">the_string</span>)
|
|
<span class="ruby-keyword">if</span> <span class="ruby-regexp">/^[a-zA-Z0-9][a-zA-Z0-9-]{1,61}[a-zA-Z0-9]\.[a-zA-Z]{2,}$/</span>.<span class="ruby-identifier">match</span>(<span class="ruby-identifier">the_string</span>)
|
|
<span class="ruby-keyword">true</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-keyword">false</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-c-valid_uuid-3F" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">valid_uuid?</span><span
|
|
class="method-args">(uuid=nil,strict=true)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="valid_uuid-3F-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg.rb, line 548</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">valid_uuid?</span>(<span class="ruby-identifier">uuid</span>=<span class="ruby-keyword">nil</span>,<span class="ruby-identifier">strict</span>=<span class="ruby-keyword">true</span>)
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">uuid</span>.<span class="ruby-identifier">is_any?</span>(<span class="ruby-operator">::</span><span class="ruby-constant">String</span>, <span class="ruby-operator">::</span><span class="ruby-constant">Symbol</span>)
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">strict</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span>
|
|
<span class="ruby-identifier">pattern</span> = <span class="ruby-regexp">/[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]-[0-9a-f][0-9a-f][0-9a-f][0-9a-f]-[4][0-9a-f][0-9a-f][0-9a-f]-[0-9a-f][0-9a-f][0-9a-f][0-9a-f]-[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]/</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">pattern</span> = <span class="ruby-regexp">/[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]-[0-9a-f][0-9a-f][0-9a-f][0-9a-f]-[0-9a-f][0-9a-f][0-9a-f][0-9a-f]-[0-9a-f][0-9a-f][0-9a-f][0-9a-f]-[0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f][0-9a-f]/</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">uuid</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">match</span>(<span class="ruby-identifier">pattern</span>)
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">uuid</span>.<span class="ruby-identifier">to_s</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">==</span> <span class="ruby-value">36</span>
|
|
<span class="ruby-keyword">true</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-keyword">false</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-keyword">false</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-keyword">false</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
</section>
|
|
|
|
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
|
|
<header>
|
|
<h3>Public Instance Methods</h3>
|
|
</header>
|
|
|
|
|
|
<div id="method-i-find_local" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">find_local</span><span
|
|
class="method-args">(the_key)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="find_local-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_entities.rb, line 6</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">find_local</span>(<span class="ruby-identifier">the_key</span>)
|
|
<span class="ruby-keyword">nil</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>
|
|
|