notifyhub 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (28) hide show
  1. data/CHANGELOG.rdoc +3 -0
  2. data/LICENSE +20 -0
  3. data/README.rdoc +19 -0
  4. data/Rakefile +28 -0
  5. data/doc/Master.html +396 -0
  6. data/doc/Notify.html +432 -0
  7. data/doc/NotifyHub/NotFound.html +134 -0
  8. data/doc/NotifyHub/Redefining.html +134 -0
  9. data/doc/NotifyHub.html +1312 -0
  10. data/doc/NotifySet.html +762 -0
  11. data/doc/_index.html +145 -0
  12. data/doc/class_list.html +53 -0
  13. data/doc/css/common.css +1 -0
  14. data/doc/css/full_list.css +57 -0
  15. data/doc/css/style.css +338 -0
  16. data/doc/file.CHANGELOG.html +79 -0
  17. data/doc/file.README.html +93 -0
  18. data/doc/file_list.html +58 -0
  19. data/doc/frames.html +28 -0
  20. data/doc/index.html +93 -0
  21. data/doc/js/app.js +214 -0
  22. data/doc/js/full_list.js +178 -0
  23. data/doc/js/jquery.js +4 -0
  24. data/doc/method_list.html +178 -0
  25. data/doc/top-level-namespace.html +112 -0
  26. data/lib/notifyhub.rb +339 -0
  27. data/test/test_notifyhub.rb +229 -0
  28. metadata +92 -0
data/CHANGELOG.rdoc ADDED
@@ -0,0 +1,3 @@
1
+ = Version history
2
+
3
+ [0.0.1] Initial version.
data/LICENSE ADDED
@@ -0,0 +1,20 @@
1
+ Copyright (c) 2014 tero.isannainen@gmail.com
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.rdoc ADDED
@@ -0,0 +1,19 @@
1
+ = NotifyHub
2
+
3
+ == Description
4
+
5
+ NotifyHub is a callback facility. NotifyHub is used by the informer
6
+ to notify clients about arbitrary events in the informer. NotifyHub
7
+ contains notification sets (NotifySet).
8
+
9
+ NotifySet is identified by set ID and it can include one or many
10
+ notifications (Notify). Client defines the action performed at
11
+ notification (callback). Informer activates the notification when
12
+ notification events occur.
13
+
14
+ Notifications can be enabled/disabled on different levels
15
+ (NotifyHub, NotifySet, and Notify).
16
+
17
+ == Documentation
18
+
19
+ Main documentation is generated from NotifyHub source.
data/Rakefile ADDED
@@ -0,0 +1,28 @@
1
+ require 'rake/testtask'
2
+
3
+ Rake::TestTask.new do |t|
4
+ t.libs << 'test'
5
+ end
6
+
7
+ desc "Run tests"
8
+ task :default => :test
9
+
10
+ task :cleanup_test do
11
+ sh "rm -rf test/test"
12
+ end
13
+
14
+ task :build => :doc do
15
+ sh "gem build notifyhub.gemspec"
16
+ end
17
+
18
+ task :doc do
19
+ sh "yardoc lib/* - README.rdoc CHANGELOG.rdoc"
20
+ end
21
+
22
+ task :publish do
23
+ if Dir.glob('notifyhub-*gem').length == 1
24
+ sh "gem push notifyhub*.gem"
25
+ else
26
+ raise "Multiple gems in the directory..."
27
+ end
28
+ end
data/doc/Master.html ADDED
@@ -0,0 +1,396 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Class: Master
8
+
9
+ &mdash; Documentation by YARD 0.8.6.1
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '';
20
+ framesUrl = "frames.html#!" + escape(window.location.href);
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="_index.html">Index (M)</a> &raquo;
35
+
36
+
37
+ <span class="title">Master</span>
38
+
39
+
40
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
+ </div>
42
+
43
+ <div id="search">
44
+
45
+ <a class="full_list_link" id="class_list_link"
46
+ href="class_list.html">
47
+ Class List
48
+ </a>
49
+
50
+ <a class="full_list_link" id="method_list_link"
51
+ href="method_list.html">
52
+ Method List
53
+ </a>
54
+
55
+ <a class="full_list_link" id="file_list_link"
56
+ href="file_list.html">
57
+ File List
58
+ </a>
59
+
60
+ </div>
61
+ <div class="clear"></div>
62
+ </div>
63
+
64
+ <iframe id="search_frame"></iframe>
65
+
66
+ <div id="content"><h1>Class: Master
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+ <dt class="r1">Inherits:</dt>
75
+ <dd class="r1">
76
+ <span class="inheritName">Object</span>
77
+
78
+ <ul class="fullTree">
79
+ <li>Object</li>
80
+
81
+ <li class="next">Master</li>
82
+
83
+ </ul>
84
+ <a href="#" class="inheritanceTree">show all</a>
85
+
86
+ </dd>
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+ <dt class="r2 last">Defined in:</dt>
97
+ <dd class="r2 last">lib/notifyhub.rb</dd>
98
+
99
+ </dl>
100
+ <div class="clear"></div>
101
+
102
+
103
+
104
+
105
+
106
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
107
+ <ul class="summary">
108
+
109
+ <li class="public ">
110
+ <span class="summary_signature">
111
+
112
+ <a href="#hub-instance_method" title="#hub (instance method)">- (Object) <strong>hub</strong> </a>
113
+
114
+
115
+
116
+ </span>
117
+
118
+
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+ <span class="summary_desc"><div class='inline'>
130
+ <p>Returns the value of attribute hub.</p>
131
+ </div></span>
132
+
133
+ </li>
134
+
135
+
136
+ </ul>
137
+
138
+
139
+
140
+
141
+
142
+ <h2>
143
+ Instance Method Summary
144
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
145
+ </h2>
146
+
147
+ <ul class="summary">
148
+
149
+ <li class="public ">
150
+ <span class="summary_signature">
151
+
152
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (Master) <strong>initialize</strong> </a>
153
+
154
+
155
+
156
+ </span>
157
+
158
+
159
+ <span class="note title constructor">constructor</span>
160
+
161
+
162
+
163
+
164
+
165
+
166
+
167
+
168
+ <span class="summary_desc"><div class='inline'>
169
+ <p>A new instance of Master.</p>
170
+ </div></span>
171
+
172
+ </li>
173
+
174
+
175
+ <li class="public ">
176
+ <span class="summary_signature">
177
+
178
+ <a href="#receive-instance_method" title="#receive (instance method)">- (Object) <strong>receive</strong> </a>
179
+
180
+
181
+
182
+ </span>
183
+
184
+
185
+
186
+
187
+
188
+
189
+
190
+
191
+
192
+ <span class="summary_desc"><div class='inline'></div></span>
193
+
194
+ </li>
195
+
196
+
197
+ <li class="public ">
198
+ <span class="summary_signature">
199
+
200
+ <a href="#send-instance_method" title="#send (instance method)">- (Object) <strong>send</strong>(data) </a>
201
+
202
+
203
+
204
+ </span>
205
+
206
+
207
+
208
+
209
+
210
+
211
+
212
+
213
+
214
+ <span class="summary_desc"><div class='inline'></div></span>
215
+
216
+ </li>
217
+
218
+
219
+ </ul>
220
+
221
+
222
+ <div id="constructor_details" class="method_details_list">
223
+ <h2>Constructor Details</h2>
224
+
225
+ <div class="method_details first">
226
+ <h3 class="signature first" id="initialize-instance_method">
227
+
228
+ - (<tt><span class='object_link'><a href="" title="Master (class)">Master</a></span></tt>) <strong>initialize</strong>
229
+
230
+
231
+
232
+
233
+
234
+ </h3><div class="docstring">
235
+ <div class="discussion">
236
+
237
+ <p>A new instance of Master</p>
238
+
239
+
240
+ </div>
241
+ </div>
242
+ <div class="tags">
243
+
244
+
245
+ </div><table class="source_code">
246
+ <tr>
247
+ <td>
248
+ <pre class="lines">
249
+
250
+
251
+ 350
252
+ 351
253
+ 352</pre>
254
+ </td>
255
+ <td>
256
+ <pre class="code"><span class="info file"># File 'lib/notifyhub.rb', line 350</span>
257
+
258
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
259
+ <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'>:send</span><span class='comma'>,</span> <span class='symbol'>:receive</span><span class='comma'>,</span> <span class='symbol'>:na</span> <span class='rparen'>)</span>
260
+ <span class='kw'>end</span></pre>
261
+ </td>
262
+ </tr>
263
+ </table>
264
+ </div>
265
+
266
+ </div>
267
+
268
+ <div id="instance_attr_details" class="attr_details">
269
+ <h2>Instance Attribute Details</h2>
270
+
271
+
272
+ <span id="hub=-instance_method"></span>
273
+ <div class="method_details first">
274
+ <h3 class="signature first" id="hub-instance_method">
275
+
276
+ - (<tt>Object</tt>) <strong>hub</strong>
277
+
278
+
279
+
280
+
281
+
282
+ </h3><div class="docstring">
283
+ <div class="discussion">
284
+
285
+ <p>Returns the value of attribute hub</p>
286
+
287
+
288
+ </div>
289
+ </div>
290
+ <div class="tags">
291
+
292
+
293
+ </div><table class="source_code">
294
+ <tr>
295
+ <td>
296
+ <pre class="lines">
297
+
298
+
299
+ 348
300
+ 349
301
+ 350</pre>
302
+ </td>
303
+ <td>
304
+ <pre class="code"><span class="info file"># File 'lib/notifyhub.rb', line 348</span>
305
+
306
+ <span class='kw'>def</span> <span class='id identifier rubyid_hub'>hub</span>
307
+ <span class='ivar'>@hub</span>
308
+ <span class='kw'>end</span></pre>
309
+ </td>
310
+ </tr>
311
+ </table>
312
+ </div>
313
+
314
+ </div>
315
+
316
+
317
+ <div id="instance_method_details" class="method_details_list">
318
+ <h2>Instance Method Details</h2>
319
+
320
+
321
+ <div class="method_details first">
322
+ <h3 class="signature first" id="receive-instance_method">
323
+
324
+ - (<tt>Object</tt>) <strong>receive</strong>
325
+
326
+
327
+
328
+
329
+
330
+ </h3><table class="source_code">
331
+ <tr>
332
+ <td>
333
+ <pre class="lines">
334
+
335
+
336
+ 359
337
+ 360
338
+ 361
339
+ 362</pre>
340
+ </td>
341
+ <td>
342
+ <pre class="code"><span class="info file"># File 'lib/notifyhub.rb', line 359</span>
343
+
344
+ <span class='kw'>def</span> <span class='id identifier rubyid_receive'>receive</span>
345
+ <span class='ivar'>@hub</span><span class='lbracket'>[</span> <span class='symbol'>:receive</span> <span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_notify'>notify</span><span class='lparen'>(</span> <span class='ivar'>@data</span> <span class='rparen'>)</span>
346
+ <span class='ivar'>@data</span>
347
+ <span class='kw'>end</span></pre>
348
+ </td>
349
+ </tr>
350
+ </table>
351
+ </div>
352
+
353
+ <div class="method_details ">
354
+ <h3 class="signature " id="send-instance_method">
355
+
356
+ - (<tt>Object</tt>) <strong>send</strong>(data)
357
+
358
+
359
+
360
+
361
+
362
+ </h3><table class="source_code">
363
+ <tr>
364
+ <td>
365
+ <pre class="lines">
366
+
367
+
368
+ 354
369
+ 355
370
+ 356
371
+ 357</pre>
372
+ </td>
373
+ <td>
374
+ <pre class="code"><span class="info file"># File 'lib/notifyhub.rb', line 354</span>
375
+
376
+ <span class='kw'>def</span> <span class='id identifier rubyid_send'>send</span><span class='lparen'>(</span> <span class='id identifier rubyid_data'>data</span> <span class='rparen'>)</span>
377
+ <span class='ivar'>@data</span> <span class='op'>=</span> <span class='id identifier rubyid_data'>data</span>
378
+ <span class='ivar'>@hub</span><span class='lbracket'>[</span> <span class='symbol'>:send</span> <span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_notify'>notify</span><span class='lparen'>(</span> <span class='ivar'>@data</span> <span class='rparen'>)</span>
379
+ <span class='kw'>end</span></pre>
380
+ </td>
381
+ </tr>
382
+ </table>
383
+ </div>
384
+
385
+ </div>
386
+
387
+ </div>
388
+
389
+ <div id="footer">
390
+ Generated on Sun Jan 19 21:48:47 2014 by
391
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
392
+ 0.8.6.1 (ruby-1.9.3).
393
+ </div>
394
+
395
+ </body>
396
+ </html>