notifyhub 0.0.2 → 0.0.3

data/doc/NotifyHub.html

@@ -94,7 +94,9 @@
   
   
     <dt class="r2 last">Defined in:</dt>
-    <dd class="r2 last">lib/notifyhub.rb</dd>
+    <dd class="r2 last">lib/notifyhub.rb<span class="defines">,<br />
+  lib/version.rb</span>
+</dd>
   
 </dl>
 <div class="clear"></div>
@@ -102,19 +104,19 @@
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
     
-<p>NotifyHub is a callback facility. NotifyHub is used by the informer to
-notify clients about arbitrary events in the informer. NotifyHub contains
-notification sets (NotifySet).</p>
+<p><span class='object_link'><a href="" title="NotifyHub (class)">NotifyHub</a></span> is a callback facility. <span class='object_link'><a href="" title="NotifyHub (class)">NotifyHub</a></span> is used by the informer to
+notify clients about arbitrary events in the informer. <span class='object_link'><a href="" title="NotifyHub (class)">NotifyHub</a></span> contains
+notification sets (<span class='object_link'><a href="NotifySet.html" title="NotifySet (class)">NotifySet</a></span>).</p>
 
-<p>NotifySet is identified by set ID and it can include one or many
-notifications (Notify). Client defines the action performed at notification
-(callback). Informer activates the notification when notification events
-occur.</p>
+<p><span class='object_link'><a href="NotifySet.html" title="NotifySet (class)">NotifySet</a></span> is identified by set ID and it can include one or many
+notifications (<span class='object_link'><a href="Notify.html" title="Notify (class)">Notify</a></span>). Client defines the action performed at
+notification (callback). Informer activates the notification when
+notification events occur.</p>
 
-<p>Notifications can be enabled/disabled on different levels (NotifyHub,
-NotifySet, and Notify).</p>
+<p>Notifications can be enabled/disabled on different levels (<span class='object_link'><a href="" title="NotifyHub (class)">NotifyHub</a></span>,
+<span class='object_link'><a href="NotifySet.html" title="NotifySet (class)">NotifySet</a></span>, and <span class='object_link'><a href="Notify.html" title="Notify (class)">Notify</a></span>).</p>
 
-<p>Example:</p>
+<p>Usage example:</p>
 
 <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>notifyhub</span><span class='tstring_end'>'</span></span>
 
@@ -125,7 +127,7 @@ NotifySet, and Notify).</p>
 </span>    <span class='id identifier rubyid_attr_accessor'>attr_accessor</span> <span class='symbol'>:hub</span>
 
     <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
-        <span class='comment'># Create NotifyHub.
+        <span class='comment'># Create NotifyHub with 3 callbacks.
 </span>        <span class='ivar'>@hub</span> <span class='op'>=</span> <span class='const'>NotifyHub</span><span class='period'>.</span><span class='id identifier rubyid_declare'>declare</span><span class='lparen'>(</span> <span class='symbol'>:store</span><span class='comma'>,</span> <span class='symbol'>:load</span><span class='comma'>,</span> <span class='symbol'>:na</span> <span class='rparen'>)</span>
     <span class='kw'>end</span>
 
@@ -151,13 +153,18 @@ NotifySet, and Notify).</p>
 
 <span class='comment'># Setup notify action for load.
 </span><span class='id identifier rubyid_storage'>storage</span><span class='period'>.</span><span class='id identifier rubyid_hub'>hub</span><span class='lbracket'>[</span> <span class='symbol'>:load</span> <span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_action'>action</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_data'>data</span><span class='op'>|</span>
-    <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>load: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_data'>data</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span>
+    <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>load:  </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_data'>data</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span>
 <span class='kw'>end</span>
 
 <span class='comment'># Use storage and get notifications.
 </span><span class='id identifier rubyid_storage'>storage</span><span class='period'>.</span><span class='id identifier rubyid_store'>store</span><span class='lparen'>(</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>my data</span><span class='tstring_end'>&quot;</span></span> <span class='rparen'>)</span>
 <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='id identifier rubyid_storage'>storage</span><span class='period'>.</span><span class='id identifier rubyid_load'>load</span></code></pre>
 
+<p>Produces:</p>
+
+<pre class="code ruby"><code class="ruby">store: my data
+load:  my data</code></pre>
+
 
   </div>
 </div>
@@ -175,6 +182,18 @@ NotifySet, and Notify).</p>
   
 </p>
 
+  <h2>Constant Summary</h2>
+  
+    <dl class="constants">
+      
+        <dt id="VERSION-constant" class="">VERSION =
+          
+        </dt>
+        <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.0.3</span><span class='tstring_end'>&quot;</span></span></pre></dd>
+      
+    </dl>
+  
+
 
 
 
@@ -239,7 +258,7 @@ NotifySet, and Notify).</p>
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Create NotifyHub and with autodeclare for sets.</p>
+<p>Create <span class='object_link'><a href="" title="NotifyHub (class)">NotifyHub</a></span> and with autodeclare for sets.</p>
 </div></span>
   
 </li>
@@ -263,7 +282,7 @@ NotifySet, and Notify).</p>
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Create NotifyHub and run block with it.</p>
+<p>Create <span class='object_link'><a href="" title="NotifyHub (class)">NotifyHub</a></span> and run block with it.</p>
 </div></span>
   
 </li>
@@ -287,9 +306,31 @@ NotifySet, and Notify).</p>
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Create NotifyHub and declare sets.</p>
+<p>Create <span class='object_link'><a href="" title="NotifyHub (class)">NotifyHub</a></span> and declare sets.</p>
 </div></span>
   
+</li>
+
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#version-class_method" title="version (class method)">+ (Object) <strong>version</strong> </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'></div></span>
+  
 </li>
 
       
@@ -320,7 +361,7 @@ NotifySet, and Notify).</p>
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Get NotifySet by ID.</p>
+<p>Get <span class='object_link'><a href="NotifySet.html" title="NotifySet (class)">NotifySet</a></span> by ID.</p>
 </div></span>
   
 </li>
@@ -346,7 +387,7 @@ NotifySet, and Notify).</p>
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Register action to NotifySet.</p>
+<p>Register action to <span class='object_link'><a href="NotifySet.html" title="NotifySet (class)">NotifySet</a></span>.</p>
 </div></span>
   
 </li>
@@ -370,7 +411,7 @@ NotifySet, and Notify).</p>
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Declare Notify by set.</p>
+<p>Declare <span class='object_link'><a href="Notify.html" title="Notify (class)">Notify</a></span> by set.</p>
 </div></span>
   
 </li>
@@ -394,7 +435,7 @@ NotifySet, and Notify).</p>
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Enable/disable Notify set or all if not set.</p>
+<p>Enable/disable <span class='object_link'><a href="Notify.html" title="Notify (class)">Notify</a></span> set or all if not set.</p>
 </div></span>
   
 </li>
@@ -418,7 +459,7 @@ NotifySet, and Notify).</p>
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Get list of NotifySet IDs.</p>
+<p>Get list of <span class='object_link'><a href="NotifySet.html" title="NotifySet (class)">NotifySet</a></span> IDs.</p>
 </div></span>
   
 </li>
@@ -468,7 +509,7 @@ NotifySet, and Notify).</p>
 
   
     <span class="summary_desc"><div class='inline'>
-<p>Run all notifiers in Notify set.</p>
+<p>Run all notifiers in <span class='object_link'><a href="Notify.html" title="Notify (class)">Notify</a></span> set.</p>
 </div></span>
   
 </li>
@@ -550,14 +591,14 @@ NotifySet, and Notify).</p>
       <pre class="lines">
 
 
-107
-108
-109
-110
-111</pre>
+111
+112
+113
+114
+115</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/notifyhub.rb', line 107</span>
+      <pre class="code"><span class="info file"># File 'lib/notifyhub.rb', line 111</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span> <span class='op'>*</span><span class='id identifier rubyid_id'>id</span> <span class='rparen'>)</span>
     <span class='ivar'>@autodeclare</span> <span class='op'>=</span> <span class='kw'>false</span>
@@ -602,12 +643,12 @@ NotifySet, and Notify).</p>
       <pre class="lines">
 
 
-63
-64
-65</pre>
+67
+68
+69</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/notifyhub.rb', line 63</span>
+      <pre class="code"><span class="info file"># File 'lib/notifyhub.rb', line 67</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_autodeclare'>autodeclare</span>
   <span class='ivar'>@autodeclare</span>
@@ -636,8 +677,8 @@ NotifySet, and Notify).</p>
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Create NotifyHub and with autodeclare for sets. Declare sets automatically
-at action registration.</p>
+<p>Create <span class='object_link'><a href="" title="NotifyHub (class)">NotifyHub</a></span> and with autodeclare for sets. Declare sets
+automatically at action registration.</p>
 
 
   </div>
@@ -671,14 +712,14 @@ at action registration.</p>
       <pre class="lines">
 
 
-85
-86
-87
-88
-89</pre>
+89
+90
+91
+92
+93</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/notifyhub.rb', line 85</span>
+      <pre class="code"><span class="info file"># File 'lib/notifyhub.rb', line 89</span>
 
 <span class='kw'>def</span> <span class='const'>NotifyHub</span><span class='period'>.</span><span class='id identifier rubyid_auto'>auto</span><span class='lparen'>(</span> <span class='op'>*</span><span class='id identifier rubyid_id'>id</span> <span class='rparen'>)</span>
     <span class='id identifier rubyid_n'>n</span> <span class='op'>=</span> <span class='const'>NotifyHub</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span> <span class='op'>*</span><span class='id identifier rubyid_id'>id</span> <span class='rparen'>)</span>
@@ -702,7 +743,7 @@ at action registration.</p>
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Create NotifyHub and run block with it.</p>
+<p>Create <span class='object_link'><a href="" title="NotifyHub (class)">NotifyHub</a></span> and run block with it.</p>
 
 
   </div>
@@ -734,16 +775,16 @@ at action registration.</p>
       <pre class="lines">
 
 
-95
-96
-97
-98
 99
 100
-101</pre>
+101
+102
+103
+104
+105</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/notifyhub.rb', line 95</span>
+      <pre class="code"><span class="info file"># File 'lib/notifyhub.rb', line 99</span>
 
 <span class='kw'>def</span> <span class='const'>NotifyHub</span><span class='period'>.</span><span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span> <span class='op'>&amp;</span><span class='id identifier rubyid_blk'>blk</span> <span class='rparen'>)</span>
     <span class='id identifier rubyid_cg'>cg</span> <span class='op'>=</span> <span class='const'>NotifyHub</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
@@ -769,7 +810,7 @@ at action registration.</p>
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Create NotifyHub and declare sets.</p>
+<p>Create <span class='object_link'><a href="" title="NotifyHub (class)">NotifyHub</a></span> and declare sets.</p>
 
 
   </div>
@@ -803,12 +844,12 @@ at action registration.</p>
       <pre class="lines">
 
 
-76
-77
-78</pre>
+80
+81
+82</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/notifyhub.rb', line 76</span>
+      <pre class="code"><span class="info file"># File 'lib/notifyhub.rb', line 80</span>
 
 <span class='kw'>def</span> <span class='const'>NotifyHub</span><span class='period'>.</span><span class='id identifier rubyid_declare'>declare</span><span class='lparen'>(</span> <span class='op'>*</span><span class='id identifier rubyid_id'>id</span> <span class='rparen'>)</span>
     <span class='const'>NotifyHub</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span> <span class='op'>*</span><span class='id identifier rubyid_id'>id</span> <span class='rparen'>)</span>
@@ -816,6 +857,36 @@ at action registration.</p>
     </td>
   </tr>
 </table>
+</div>
+    
+      <div class="method_details ">
+  <h3 class="signature " id="version-class_method">
+  
+    + (<tt>Object</tt>) <strong>version</strong> 
+  
+
+  
+
+  
+</h3><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+3
+4
+5</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/version.rb', line 3</span>
+
+<span class='kw'>def</span> <span class='const'>NotifyHub</span><span class='period'>.</span><span class='id identifier rubyid_version'>version</span>
+    <span class='const'>NotifyHub</span><span class='op'>::</span><span class='const'>VERSION</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
 </div>
     
   </div>
@@ -836,7 +907,7 @@ at action registration.</p>
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Get NotifySet by ID.</p>
+<p>Get <span class='object_link'><a href="NotifySet.html" title="NotifySet (class)">NotifySet</a></span> by ID.</p>
 
 
   </div>
@@ -888,14 +959,14 @@ at action registration.</p>
       <pre class="lines">
 
 
-186
-187
-188
-189
-190</pre>
+190
+191
+192
+193
+194</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/notifyhub.rb', line 186</span>
+      <pre class="code"><span class="info file"># File 'lib/notifyhub.rb', line 190</span>
 
 <span class='kw'>def</span> <span class='op'>[]</span><span class='lparen'>(</span> <span class='id identifier rubyid_id'>id</span> <span class='rparen'>)</span>
     <span class='id identifier rubyid_useSet'>useSet</span><span class='lparen'>(</span> <span class='id identifier rubyid_id'>id</span> <span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_set'>set</span><span class='op'>|</span>
@@ -923,7 +994,7 @@ at action registration.</p>
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Register action to NotifySet. Multiple notifies can exist per set.</p>
+<p>Register action to <span class='object_link'><a href="NotifySet.html" title="NotifySet (class)">NotifySet</a></span>. Multiple notifies can exist per set.</p>
 
 
   </div>
@@ -973,18 +1044,18 @@ at action registration.</p>
       <pre class="lines">
 
 
-133
-134
-135
-136
-137</pre>
+137
+138
+139
+140
+141</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/notifyhub.rb', line 133</span>
+      <pre class="code"><span class="info file"># File 'lib/notifyhub.rb', line 137</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_action'>action</span><span class='lparen'>(</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_action'>action</span> <span class='rparen'>)</span>
     <span class='id identifier rubyid_useSet'>useSet</span><span class='lparen'>(</span> <span class='id identifier rubyid_id'>id</span> <span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_set'>set</span><span class='op'>|</span>
-        <span class='id identifier rubyid_set'>set</span><span class='period'>.</span><span class='id identifier rubyid_action'>action</span><span class='lparen'>(</span> <span class='op'>&amp;</span><span class='id identifier rubyid_action'>action</span> <span class='rparen'>)</span>            
+        <span class='id identifier rubyid_set'>set</span><span class='period'>.</span><span class='id identifier rubyid_action'>action</span><span class='lparen'>(</span> <span class='op'>&amp;</span><span class='id identifier rubyid_action'>action</span> <span class='rparen'>)</span>
     <span class='kw'>end</span>
 <span class='kw'>end</span></pre>
     </td>
@@ -1004,7 +1075,7 @@ at action registration.</p>
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Declare Notify by set. Multiple notifiers can exist per set.</p>
+<p>Declare <span class='object_link'><a href="Notify.html" title="Notify (class)">Notify</a></span> by set. Multiple notifiers can exist per set.</p>
 
 
   </div>
@@ -1038,18 +1109,18 @@ at action registration.</p>
       <pre class="lines">
 
 
-117
-118
-119
-120
 121
 122
 123
 124
-125</pre>
+125
+126
+127
+128
+129</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/notifyhub.rb', line 117</span>
+      <pre class="code"><span class="info file"># File 'lib/notifyhub.rb', line 121</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_declare'>declare</span><span class='lparen'>(</span> <span class='op'>*</span><span class='id identifier rubyid_id'>id</span> <span class='rparen'>)</span>
     <span class='id identifier rubyid_id'>id</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_i'>i</span><span class='op'>|</span>
@@ -1077,7 +1148,7 @@ at action registration.</p>
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Enable/disable Notify set or all if not set.</p>
+<p>Enable/disable <span class='object_link'><a href="Notify.html" title="Notify (class)">Notify</a></span> set or all if not set.</p>
 
 
   </div>
@@ -1127,20 +1198,20 @@ at action registration.</p>
       <pre class="lines">
 
 
-158
-159
-160
-161
 162
 163
 164
 165
 166
 167
-168</pre>
+168
+169
+170
+171
+172</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/notifyhub.rb', line 158</span>
+      <pre class="code"><span class="info file"># File 'lib/notifyhub.rb', line 162</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_enable'>enable</span><span class='lparen'>(</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span> <span class='rparen'>)</span>
     <span class='kw'>if</span> <span class='id identifier rubyid_id'>id</span>
@@ -1170,7 +1241,7 @@ at action registration.</p>
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Get list of NotifySet IDs.</p>
+<p>Get list of <span class='object_link'><a href="NotifySet.html" title="NotifySet (class)">NotifySet</a></span> IDs.</p>
 
 
   </div>
@@ -1202,12 +1273,12 @@ at action registration.</p>
       <pre class="lines">
 
 
-196
-197
-198</pre>
+200
+201
+202</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/notifyhub.rb', line 196</span>
+      <pre class="code"><span class="info file"># File 'lib/notifyhub.rb', line 200</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_ids'>ids</span>
     <span class='ivar'>@set</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span>
@@ -1229,7 +1300,7 @@ at action registration.</p>
 </h3><div class="docstring">
   <div class="discussion">
     
-<p>Run all notifiers in Notify set.</p>
+<p>Run all notifiers in <span class='object_link'><a href="Notify.html" title="Notify (class)">Notify</a></span> set.</p>
 
 
   </div>
@@ -1279,14 +1350,14 @@ at action registration.</p>
       <pre class="lines">
 
 
-175
-176
-177
-178
-179</pre>
+179
+180
+181
+182
+183</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/notifyhub.rb', line 175</span>
+      <pre class="code"><span class="info file"># File 'lib/notifyhub.rb', line 179</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_notify'>notify</span><span class='lparen'>(</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_args'>args</span> <span class='rparen'>)</span>
     <span class='id identifier rubyid_withSet'>withSet</span><span class='lparen'>(</span> <span class='id identifier rubyid_id'>id</span> <span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_set'>set</span><span class='op'>|</span>
@@ -1362,14 +1433,14 @@ at action registration.</p>
       <pre class="lines">
 
 
-147
-148
-149
-150
-151</pre>
+151
+152
+153
+154
+155</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'lib/notifyhub.rb', line 147</span>
+      <pre class="code"><span class="info file"># File 'lib/notifyhub.rb', line 151</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_remove'>remove</span><span class='lparen'>(</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span> <span class='id identifier rubyid_notify'>notify</span> <span class='op'>=</span> <span class='kw'>nil</span> <span class='rparen'>)</span>
     <span class='id identifier rubyid_withSet'>withSet</span><span class='lparen'>(</span> <span class='id identifier rubyid_id'>id</span> <span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_set'>set</span><span class='op'>|</span>
@@ -1386,7 +1457,7 @@ at action registration.</p>
 </div>
 
     <div id="footer">
-  Generated on Tue Jan 21 18:23:01 2014 by
+  Generated on Sun Nov 23 14:59:06 2014 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.8.6.1 (ruby-1.9.3).
 </div>