RubyGems - facets - Versions diffs - 2.5.2 → 2.6.0 - Mend

facets 2.5.2 → 2.6.0

Files changed (677) hide show

data/doc/rdoc/more/classes/Multiton.html DELETED

@@ -1,205 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
-     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html>
-  <head>
-    <title>Module: Multiton</title>
-    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-    <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
-    <script language="JavaScript" type="text/javascript">
-    // <![CDATA[
-        function toggleSource( id )
-        {
-          var elem
-          var link
-          if( document.getElementById )
-          {
-            elem = document.getElementById( id )
-            link = document.getElementById( "l_" + id )
-          }
-          else if ( document.all )
-          {
-            elem = eval( "document.all." + id )
-            link = eval( "document.all.l_" + id )
-          }
-          else
-            return false;
-          if( elem.style.display == "block" )
-          {
-            elem.style.display = "none"
-            link.innerHTML = "+"
-          }
-          else
-          {
-            elem.style.display = "block"
-            link.innerHTML = "-"
-          }
-        }
-        function openCode( url )
-        {
-          window.open( url, "SOURCE_CODE", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=480,width=750" ).focus();
-        }
-      // ]]>
-    </script>
-  </head>
-  <body>
-  <table width="100%" border='0' cellpadding='0' cellspacing='0' class='banner'><tr>
-  <td class="file-title"><span class="file-title-prefix">Module</span><br />Multiton</td>
-  <td align="right">
-    <table cellspacing="0" cellpadding="2">
-      <tr valign="top">
-        <td>In:</td>
-        <td>
-<a href="../files/lib/more/facets/multiton_rb.html">lib/more/facets/multiton.rb</a>
-        </td>
-      </tr>
-         </table>
-        </td>
-        </tr>
-      </table>
- <!-- banner header -->
-  <div id="bodyContent">
-      <div id="content">
-  <div class="description"><h1><a href="Multiton.html">Multiton</a></h1>
-<p>
-<a href="Multiton.html">Multiton</a> design pattern ensures only one object
-is allocated for a given state.
-</p>
-<p>
-The &#8216;multiton&#8217; pattern is similar to a singleton, but instead
-of only one instance, there are several similar instances. <a
-href="It.html">It</a> is useful when you want to avoid constructing objects
-many times because of some huge expense (connecting to a database for
-example), require a set of similar but not identical objects, and cannot
-easily control how many times a contructor may be called.
-</p>
-<pre>
-  class SomeMultitonClass
-    include Multiton
-    attr :arg
-    def initialize(arg)
-      @arg = arg
-    end
-  end
-  a = SomeMultitonClass.new(4)
-  b = SomeMultitonClass.new(4)   # a and b are same object
-  c = SomeMultitonClass.new(2)   # c is a different object
-</pre>
-<h2>How <a href="It.html">It</a> Works</h2>
-<p>
-A pool of objects is searched for a previously cached object, if one is not
-found we construct one and cache it in the pool based on class and the args
-given to the contructor.
-</p>
-<p>
-A limitation of this approach is that it is impossible to detect if
-different blocks were given to a contructor (if it takes a block). So it is
-the constructor arguments <em>only</em> which determine the uniqueness of
-an object. To workaround this, define the <em>class</em> method
-::multiton_id.
-</p>
-<pre>
-  def Klass.multiton_id(*args, &amp;block)
-    # ...
-  end
-</pre>
-<p>
-Which should return a hash key used to identify the object being
-constructed as (not) unique.
-</p>
-</div>
-  <div class="sectiontitle">Methods</div>
-  <span style="padding-right: 5px;"><a href="#M000903">_dump</a></span>
-  <span style="padding-right: 5px;"><a href="#M000901">clone</a></span>
-  <span style="padding-right: 5px;"><a href="#M000902">dup</a></span>
-  <div class="sectiontitle">Classes and Modules</div>
-  Module <a href="Multiton/Inclusive.html" class="link">Multiton::Inclusive</a><br />
-Module <a href="Multiton/MetaMethods.html" class="link">Multiton::MetaMethods</a><br />
-<div class="sectiontitle">Public Instance methods</div>
-<div class="method">
-  <div class="title">
-    <a name="M000901"></a><b>clone</b>()
-  </div>
-  <div class="description">
-  <p>
-disable build-in copying methods
-</p>
-  </div>
-<div class="sourcecode">
-  <p class="source-link">[ <a href="javascript:toggleSource('M000901_source')" id="l_M000901_source">+</a> ]</p>
-  <div id="M000901_source" class="dyn-source">
-<pre>
-<span class="ruby-comment cmt"># File lib/more/facets/multiton.rb, line 135</span>
-  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">clone</span>
-    <span class="ruby-identifier">raise</span> <span class="ruby-constant">TypeError</span>, <span class="ruby-node">&quot;can't clone Multiton #{self}&quot;</span>
-    <span class="ruby-comment cmt">#self</span>
-  <span class="ruby-keyword kw">end</span>
-</pre>
-  </div>
-</div>
-</div>
-<div class="method">
-  <div class="title">
-    <a name="M000902"></a><b>dup</b>()
-  </div>
-<div class="sourcecode">
-  <p class="source-link">[ <a href="javascript:toggleSource('M000902_source')" id="l_M000902_source">+</a> ]</p>
-  <div id="M000902_source" class="dyn-source">
-<pre>
-<span class="ruby-comment cmt"># File lib/more/facets/multiton.rb, line 140</span>
-  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">dup</span>
-    <span class="ruby-identifier">raise</span> <span class="ruby-constant">TypeError</span>, <span class="ruby-node">&quot;can't dup Multiton #{self}&quot;</span>
-    <span class="ruby-comment cmt">#self</span>
-  <span class="ruby-keyword kw">end</span>
-</pre>
-  </div>
-</div>
-</div>
-<div class="sectiontitle">Protected Instance methods</div>
-<div class="method">
-  <div class="title">
-    <a name="M000903"></a><b>_dump</b>(depth=-1)
-  </div>
-  <div class="description">
-  <p>
-default marshalling strategy
-</p>
-  </div>
-<div class="sourcecode">
-  <p class="source-link">[ <a href="javascript:toggleSource('M000903_source')" id="l_M000903_source">+</a> ]</p>
-  <div id="M000903_source" class="dyn-source">
-<pre>
-<span class="ruby-comment cmt"># File lib/more/facets/multiton.rb, line 149</span>
-  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">_dump</span>(<span class="ruby-identifier">depth</span>=<span class="ruby-value">-1</span>)
-    <span class="ruby-constant">Marshal</span>.<span class="ruby-identifier">dump</span>(<span class="ruby-ivar">@multiton_initializer</span>)
-  <span class="ruby-keyword kw">end</span>
-</pre>
-  </div>
-</div>
-</div>
-</div>
-  </div>
-    </body>
-</html>

data/doc/rdoc/more/classes/Multiton/Inclusive.html DELETED

@@ -1,93 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
-     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html>
-  <head>
-    <title>Module: Multiton::Inclusive</title>
-    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-    <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
-    <script language="JavaScript" type="text/javascript">
-    // <![CDATA[
-        function toggleSource( id )
-        {
-          var elem
-          var link
-          if( document.getElementById )
-          {
-            elem = document.getElementById( id )
-            link = document.getElementById( "l_" + id )
-          }
-          else if ( document.all )
-          {
-            elem = eval( "document.all." + id )
-            link = eval( "document.all.l_" + id )
-          }
-          else
-            return false;
-          if( elem.style.display == "block" )
-          {
-            elem.style.display = "none"
-            link.innerHTML = "+"
-          }
-          else
-          {
-            elem.style.display = "block"
-            link.innerHTML = "-"
-          }
-        }
-        function openCode( url )
-        {
-          window.open( url, "SOURCE_CODE", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=480,width=750" ).focus();
-        }
-      // ]]>
-    </script>
-  </head>
-  <body>
-  <table width="100%" border='0' cellpadding='0' cellspacing='0' class='banner'><tr>
-  <td class="file-title"><span class="file-title-prefix">Module</span><br />Multiton::Inclusive</td>
-  <td align="right">
-    <table cellspacing="0" cellpadding="2">
-      <tr valign="top">
-        <td>In:</td>
-        <td>
-<a href="../../files/lib/more/facets/multiton_rb.html">lib/more/facets/multiton.rb</a>
-        </td>
-      </tr>
-         </table>
-        </td>
-        </tr>
-      </table>
- <!-- banner header -->
-  <div id="bodyContent">
-      <div id="content">
-  <div class="description"><p>
-<a href="../Multiton.html">Multiton</a> can be included in another module,
-in which case that module effectively becomes a multiton behavior
-distributor too. This is why we propogate included to the base module. by
-putting it in another module.
-</p>
-</div>
-</div>
-  </div>
-    </body>
-</html>

data/doc/rdoc/more/classes/Multiton/MetaMethods.html DELETED

@@ -1,221 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
-     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html>
-  <head>
-    <title>Module: Multiton::MetaMethods</title>
-    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-    <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
-    <script language="JavaScript" type="text/javascript">
-    // <![CDATA[
-        function toggleSource( id )
-        {
-          var elem
-          var link
-          if( document.getElementById )
-          {
-            elem = document.getElementById( id )
-            link = document.getElementById( "l_" + id )
-          }
-          else if ( document.all )
-          {
-            elem = eval( "document.all." + id )
-            link = eval( "document.all.l_" + id )
-          }
-          else
-            return false;
-          if( elem.style.display == "block" )
-          {
-            elem.style.display = "none"
-            link.innerHTML = "+"
-          }
-          else
-          {
-            elem.style.display = "block"
-            link.innerHTML = "-"
-          }
-        }
-        function openCode( url )
-        {
-          window.open( url, "SOURCE_CODE", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=480,width=750" ).focus();
-        }
-      // ]]>
-    </script>
-  </head>
-  <body>
-  <table width="100%" border='0' cellpadding='0' cellspacing='0' class='banner'><tr>
-  <td class="file-title"><span class="file-title-prefix">Module</span><br />Multiton::MetaMethods</td>
-  <td align="right">
-    <table cellspacing="0" cellpadding="2">
-      <tr valign="top">
-        <td>In:</td>
-        <td>
-<a href="../../files/lib/more/facets/multiton_rb.html">lib/more/facets/multiton.rb</a>
-        </td>
-      </tr>
-         </table>
-        </td>
-        </tr>
-      </table>
- <!-- banner header -->
-  <div id="bodyContent">
-      <div id="content">
-  <div class="sectiontitle">Methods</div>
-  <span style="padding-right: 5px;"><a href="#M000910">_load</a></span>
-  <span style="padding-right: 5px;"><a href="#M000906">initialized?</a></span>
-  <span style="padding-right: 5px;"><a href="#M000904">instance</a></span>
-  <span style="padding-right: 5px;"><a href="#M000907">multiton_instance</a></span>
-  <span style="padding-right: 5px;"><a href="#M000908">multiton_mutex</a></span>
-  <span style="padding-right: 5px;"><a href="#M000905">new</a></span>
-  <span style="padding-right: 5px;"><a href="#M000909">reinitialize</a></span>
-<div class="sectiontitle">Included Modules</div>
-<ul>
-  <li><a href="Inclusive.html">Inclusive</a></li>
-</ul>
-<div class="sectiontitle">Public Instance methods</div>
-<div class="method">
-  <div class="title">
-    <a name="M000906"></a><b>initialized?</b>(*e, &amp;b)
-  </div>
-<div class="sourcecode">
-  <p class="source-link">[ <a href="javascript:toggleSource('M000906_source')" id="l_M000906_source">+</a> ]</p>
-  <div id="M000906_source" class="dyn-source">
-<pre>
-<span class="ruby-comment cmt"># File lib/more/facets/multiton.rb, line 230</span>
-    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialized?</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">e</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">b</span>)
-      <span class="ruby-identifier">multiton_instance</span>.<span class="ruby-identifier">key?</span>(<span class="ruby-identifier">multiton_id</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">e</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">b</span>))
-    <span class="ruby-keyword kw">end</span>
-</pre>
-  </div>
-</div>
-</div>
-<div class="method">
-  <div class="title">
-    <a name="M000904"></a><b>instance</b>(*e, &amp;b)
-  </div>
-<div class="aka">
-  This method is also aliased as
-  <a href="MetaMethods.html#M000905">new</a>
-</div>
-<div class="sourcecode">
-  <p class="source-link">[ <a href="javascript:toggleSource('M000904_source')" id="l_M000904_source">+</a> ]</p>
-  <div id="M000904_source" class="dyn-source">
-<pre>
-<span class="ruby-comment cmt"># File lib/more/facets/multiton.rb, line 215</span>
-    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">instance</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">e</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">b</span>)
-      <span class="ruby-identifier">arg</span> = <span class="ruby-identifier">multiton_id</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">e</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">b</span>)
-      <span class="ruby-identifier">multiton_instance</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">arg</span>) <span class="ruby-keyword kw">do</span>
-        <span class="ruby-identifier">multiton_mutex</span>[<span class="ruby-identifier">arg</span>].<span class="ruby-identifier">synchronize</span> <span class="ruby-keyword kw">do</span>
-          <span class="ruby-identifier">multiton_instance</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-identifier">arg</span>) <span class="ruby-keyword kw">do</span>
-            <span class="ruby-identifier">val</span> = <span class="ruby-identifier">multiton_instance</span>[<span class="ruby-identifier">arg</span>] = <span class="ruby-identifier">new!</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">e</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">b</span>) <span class="ruby-comment cmt">#new(*e, &amp;b)</span>
-            <span class="ruby-identifier">val</span>.<span class="ruby-identifier">instance_variable_set</span>(<span class="ruby-identifier">:@multiton_initializer</span>, <span class="ruby-identifier">e</span>, <span class="ruby-operator">&amp;</span><span class="ruby-identifier">b</span>)
-            <span class="ruby-identifier">multiton_mutex</span>.<span class="ruby-identifier">initialized</span>(<span class="ruby-identifier">arg</span>)
-            <span class="ruby-identifier">val</span>
-          <span class="ruby-keyword kw">end</span>
-        <span class="ruby-keyword kw">end</span>
-      <span class="ruby-keyword kw">end</span>
-    <span class="ruby-keyword kw">end</span>
-</pre>
-  </div>
-</div>
-</div>
-<div class="method">
-  <div class="title">
-    <a name="M000905"></a><b>new</b>(*e, &amp;b)
-  </div>
-  <div class="description">
-  <p>
-Alias for <a href="MetaMethods.html#M000904">instance</a>
-</p>
-  </div>
-</div>
-<div class="sectiontitle">Protected Instance methods</div>
-<div class="method">
-  <div class="title">
-    <a name="M000910"></a><b>_load</b>(str)
-  </div>
-<div class="sourcecode">
-  <p class="source-link">[ <a href="javascript:toggleSource('M000910_source')" id="l_M000910_source">+</a> ]</p>
-  <div id="M000910_source" class="dyn-source">
-<pre>
-<span class="ruby-comment cmt"># File lib/more/facets/multiton.rb, line 249</span>
-    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">_load</span>(<span class="ruby-identifier">str</span>)
-      <span class="ruby-identifier">instance</span>(<span class="ruby-operator">*</span><span class="ruby-constant">Marshal</span>.<span class="ruby-identifier">load</span>(<span class="ruby-identifier">str</span>))
-    <span class="ruby-keyword kw">end</span>
-</pre>
-  </div>
-</div>
-</div>
-<div class="method">
-  <div class="title">
-    <a name="M000907"></a><b>multiton_instance</b>()
-  </div>
-<div class="sourcecode">
-  <p class="source-link">[ <a href="javascript:toggleSource('M000907_source')" id="l_M000907_source">+</a> ]</p>
-  <div id="M000907_source" class="dyn-source">
-<pre>
-<span class="ruby-comment cmt"># File lib/more/facets/multiton.rb, line 236</span>
-    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">multiton_instance</span>
-      <span class="ruby-ivar">@multiton_instance</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">Hash</span>.<span class="ruby-identifier">new</span>
-    <span class="ruby-keyword kw">end</span>
-</pre>
-  </div>
-</div>
-</div>
-<div class="method">
-  <div class="title">
-    <a name="M000908"></a><b>multiton_mutex</b>()
-  </div>
-<div class="sourcecode">
-  <p class="source-link">[ <a href="javascript:toggleSource('M000908_source')" id="l_M000908_source">+</a> ]</p>
-  <div id="M000908_source" class="dyn-source">
-<pre>
-<span class="ruby-comment cmt"># File lib/more/facets/multiton.rb, line 240</span>
-    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">multiton_mutex</span>
-      <span class="ruby-ivar">@multiton_mutex</span> <span class="ruby-operator">||=</span> <span class="ruby-constant">InstanceMutex</span>.<span class="ruby-identifier">new</span>
-    <span class="ruby-keyword kw">end</span>
-</pre>
-  </div>
-</div>
-</div>
-<div class="method">
-  <div class="title">
-    <a name="M000909"></a><b>reinitialize</b>()
-  </div>
-<div class="sourcecode">
-  <p class="source-link">[ <a href="javascript:toggleSource('M000909_source')" id="l_M000909_source">+</a> ]</p>
-  <div id="M000909_source" class="dyn-source">
-<pre>
-<span class="ruby-comment cmt"># File lib/more/facets/multiton.rb, line 244</span>
-    <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">reinitialize</span>
-      <span class="ruby-identifier">multiton_instance</span>.<span class="ruby-identifier">clear</span>
-      <span class="ruby-identifier">multiton_mutex</span>.<span class="ruby-identifier">clear</span>
-    <span class="ruby-keyword kw">end</span>
-</pre>
-  </div>
-</div>
-</div>
-</div>
-  </div>
-    </body>
-</html>