outboxer 0.1.0 → 0.1.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (32) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +50 -22
  3. data/doc/Outboxer/Models/Exception.html +124 -0
  4. data/doc/Outboxer/Models/Message.html +144 -0
  5. data/doc/Outboxer/Models/Outboxable/ClassMethods.html +105 -0
  6. data/doc/Outboxer/Models/Outboxable.html +265 -0
  7. data/doc/Outboxer/Models.html +119 -0
  8. data/doc/Outboxer/Publisher/Args.html +310 -0
  9. data/doc/Outboxer/Publisher.html +384 -0
  10. data/doc/Outboxer/Railtie.html +124 -0
  11. data/doc/Outboxer.html +150 -0
  12. data/doc/_index.html +211 -0
  13. data/doc/class_list.html +51 -0
  14. data/doc/css/common.css +1 -0
  15. data/doc/css/full_list.css +58 -0
  16. data/doc/css/style.css +497 -0
  17. data/doc/file.README.html +180 -0
  18. data/doc/file_list.html +56 -0
  19. data/doc/frames.html +17 -0
  20. data/doc/index.html +180 -0
  21. data/doc/js/app.js +314 -0
  22. data/doc/js/full_list.js +216 -0
  23. data/doc/js/jquery.js +4 -0
  24. data/doc/method_list.html +99 -0
  25. data/doc/top-level-namespace.html +110 -0
  26. data/generators/outboxer/templates/bin/publisher.rb +8 -1
  27. data/lib/outboxer/models/message.rb +2 -1
  28. data/lib/outboxer/publisher.rb +19 -0
  29. data/lib/outboxer/version.rb +1 -1
  30. data/lib/outboxer.rb +2 -0
  31. data/outboxer.gemspec +1 -1
  32. metadata +25 -15
data/doc/Outboxer/Models/Outboxable.html ADDED
@@ -0,0 +1,265 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Module: Outboxer::Models::Outboxable
8
+
9
+ &mdash; Documentation by YARD 0.9.34
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" />
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" />
16
+
17
+ <script type="text/javascript">
18
+ pathId = "Outboxer::Models::Outboxable";
19
+ relpath = '../../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../../_index.html">Index (O)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../Outboxer.html" title="Outboxer (module)">Outboxer</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Models.html" title="Outboxer::Models (module)">Models</a></span></span>
41
+ &raquo;
42
+ <span class="title">Outboxable</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Module: Outboxer::Models::Outboxable
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+
78
+
79
+ <dl>
80
+ <dt>Defined in:</dt>
81
+ <dd>lib/outboxer/models/outboxable.rb</dd>
82
+ </dl>
83
+
84
+ </div>
85
+
86
+ <h2>Defined Under Namespace</h2>
87
+ <p class="children">
88
+
89
+
90
+ <strong class="modules">Modules:</strong> <span class='object_link'><a href="Outboxable/ClassMethods.html" title="Outboxer::Models::Outboxable::ClassMethods (module)">ClassMethods</a></span>
91
+
92
+
93
+
94
+
95
+ </p>
96
+
97
+
98
+
99
+
100
+
101
+
102
+
103
+
104
+ <h2>
105
+ Class Method Summary
106
+ <small><a href="#" class="summary_toggle">collapse</a></small>
107
+ </h2>
108
+
109
+ <ul class="summary">
110
+
111
+ <li class="public ">
112
+ <span class="summary_signature">
113
+
114
+ <a href="#included-class_method" title="included (class method)">.<strong>included</strong>(base) &#x21d2; Object </a>
115
+
116
+
117
+
118
+ </span>
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+ <span class="summary_desc"><div class='inline'></div></span>
129
+
130
+ </li>
131
+
132
+
133
+ </ul>
134
+
135
+ <h2>
136
+ Instance Method Summary
137
+ <small><a href="#" class="summary_toggle">collapse</a></small>
138
+ </h2>
139
+
140
+ <ul class="summary">
141
+
142
+ <li class="public ">
143
+ <span class="summary_signature">
144
+
145
+ <a href="#create_outbox_message!-instance_method" title="#create_outbox_message! (instance method)">#<strong>create_outbox_message!</strong> &#x21d2; Object </a>
146
+
147
+
148
+
149
+ </span>
150
+
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+
159
+ <span class="summary_desc"><div class='inline'></div></span>
160
+
161
+ </li>
162
+
163
+
164
+ </ul>
165
+
166
+
167
+
168
+
169
+ <div id="class_method_details" class="method_details_list">
170
+ <h2>Class Method Details</h2>
171
+
172
+
173
+ <div class="method_details first">
174
+ <h3 class="signature first" id="included-class_method">
175
+
176
+ .<strong>included</strong>(base) &#x21d2; <tt>Object</tt>
177
+
178
+
179
+
180
+
181
+
182
+ </h3><table class="source_code">
183
+ <tr>
184
+ <td>
185
+ <pre class="lines">
186
+
187
+
188
+ 4
189
+ 5
190
+ 6
191
+ 7
192
+ 8
193
+ 9
194
+ 10
195
+ 11
196
+ 12
197
+ 13</pre>
198
+ </td>
199
+ <td>
200
+ <pre class="code"><span class="info file"># File 'lib/outboxer/models/outboxable.rb', line 4</span>
201
+
202
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_included'>included</span><span class='lparen'>(</span><span class='id identifier rubyid_base'>base</span><span class='rparen'>)</span>
203
+ <span class='id identifier rubyid_base'>base</span><span class='period'>.</span><span class='id identifier rubyid_extend'>extend</span> <span class='const'><span class='object_link'><a href="Outboxable/ClassMethods.html" title="Outboxer::Models::Outboxable::ClassMethods (module)">ClassMethods</a></span></span>
204
+
205
+ <span class='id identifier rubyid_base'>base</span><span class='period'>.</span><span class='id identifier rubyid_class_eval'>class_eval</span> <span class='kw'>do</span>
206
+ <span class='id identifier rubyid_has_one'>has_one</span> <span class='symbol'>:message</span><span class='comma'>,</span> <span class='label'>class_name:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Outboxer::Models::Message</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>as:</span> <span class='symbol'>:outbox_message</span><span class='comma'>,</span>
207
+ <span class='label'>dependent:</span> <span class='symbol'>:destroy</span>
208
+
209
+ <span class='id identifier rubyid_after_create'>after_create</span> <span class='symbol'>:create_outbox_message!</span>
210
+ <span class='kw'>end</span>
211
+ <span class='kw'>end</span></pre>
212
+ </td>
213
+ </tr>
214
+ </table>
215
+ </div>
216
+
217
+ </div>
218
+
219
+ <div id="instance_method_details" class="method_details_list">
220
+ <h2>Instance Method Details</h2>
221
+
222
+
223
+ <div class="method_details first">
224
+ <h3 class="signature first" id="create_outbox_message!-instance_method">
225
+
226
+ #<strong>create_outbox_message!</strong> &#x21d2; <tt>Object</tt>
227
+
228
+
229
+
230
+
231
+
232
+ </h3><table class="source_code">
233
+ <tr>
234
+ <td>
235
+ <pre class="lines">
236
+
237
+
238
+ 15
239
+ 16
240
+ 17</pre>
241
+ </td>
242
+ <td>
243
+ <pre class="code"><span class="info file"># File 'lib/outboxer/models/outboxable.rb', line 15</span>
244
+
245
+ <span class='kw'>def</span> <span class='id identifier rubyid_create_outbox_message!'>create_outbox_message!</span>
246
+ <span class='const'><span class='object_link'><a href="../Models.html" title="Outboxer::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Message.html" title="Outboxer::Models::Message (class)">Message</a></span></span><span class='period'>.</span><span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span><span class='label'>message:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>status:</span> <span class='const'><span class='object_link'><a href="../Models.html" title="Outboxer::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Message.html" title="Outboxer::Models::Message (class)">Message</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Message.html#STATUS-constant" title="Outboxer::Models::Message::STATUS (constant)">STATUS</a></span></span><span class='lbracket'>[</span><span class='symbol'>:unpublished</span><span class='rbracket'>]</span><span class='rparen'>)</span>
247
+ <span class='kw'>end</span></pre>
248
+ </td>
249
+ </tr>
250
+ </table>
251
+ </div>
252
+
253
+ </div>
254
+
255
+ </div>
256
+
257
+ <div id="footer">
258
+ Generated on Sat Aug 5 04:37:46 2023 by
259
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
260
+ 0.9.34 (ruby-2.7.8).
261
+ </div>
262
+
263
+ </div>
264
+ </body>
265
+ </html>
data/doc/Outboxer/Models.html ADDED
@@ -0,0 +1,119 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Module: Outboxer::Models
8
+
9
+ &mdash; Documentation by YARD 0.9.34
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" />
16
+
17
+ <script type="text/javascript">
18
+ pathId = "Outboxer::Models";
19
+ relpath = '../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../_index.html">Index (M)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../Outboxer.html" title="Outboxer (module)">Outboxer</a></span></span>
41
+ &raquo;
42
+ <span class="title">Models</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Module: Outboxer::Models
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+
78
+
79
+ <dl>
80
+ <dt>Defined in:</dt>
81
+ <dd>lib/outboxer/models/message.rb<span class="defines">,<br />
82
+ lib/outboxer/models/exception.rb,<br /> lib/outboxer/models/outboxable.rb</span>
83
+ </dd>
84
+ </dl>
85
+
86
+ </div>
87
+
88
+ <h2>Defined Under Namespace</h2>
89
+ <p class="children">
90
+
91
+
92
+ <strong class="modules">Modules:</strong> <span class='object_link'><a href="Models/Outboxable.html" title="Outboxer::Models::Outboxable (module)">Outboxable</a></span>
93
+
94
+
95
+
96
+ <strong class="classes">Classes:</strong> <span class='object_link'><a href="Models/Exception.html" title="Outboxer::Models::Exception (class)">Exception</a></span>, <span class='object_link'><a href="Models/Message.html" title="Outboxer::Models::Message (class)">Message</a></span>
97
+
98
+
99
+ </p>
100
+
101
+
102
+
103
+
104
+
105
+
106
+
107
+
108
+
109
+ </div>
110
+
111
+ <div id="footer">
112
+ Generated on Sat Aug 5 04:37:46 2023 by
113
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
114
+ 0.9.34 (ruby-2.7.8).
115
+ </div>
116
+
117
+ </div>
118
+ </body>
119
+ </html>
data/doc/Outboxer/Publisher/Args.html ADDED
@@ -0,0 +1,310 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Class: Outboxer::Publisher::Args
8
+
9
+ &mdash; Documentation by YARD 0.9.34
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" />
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" />
16
+
17
+ <script type="text/javascript">
18
+ pathId = "Outboxer::Publisher::Args";
19
+ relpath = '../../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../../_index.html">Index (A)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../Outboxer.html" title="Outboxer (module)">Outboxer</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Publisher.html" title="Outboxer::Publisher (module)">Publisher</a></span></span>
41
+ &raquo;
42
+ <span class="title">Args</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Class: Outboxer::Publisher::Args
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName">Struct</span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next">Struct</li>
78
+
79
+ <li class="next">Outboxer::Publisher::Args</li>
80
+
81
+ </ul>
82
+ <a href="#" class="inheritanceTree">show all</a>
83
+
84
+ </dd>
85
+ </dl>
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+
96
+
97
+ <dl>
98
+ <dt>Defined in:</dt>
99
+ <dd>lib/outboxer/publisher.rb</dd>
100
+ </dl>
101
+
102
+ </div>
103
+
104
+
105
+
106
+
107
+
108
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
109
+ <ul class="summary">
110
+
111
+ <li class="public ">
112
+ <span class="summary_signature">
113
+
114
+ <a href="#logger-instance_method" title="#logger (instance method)">#<strong>logger</strong> &#x21d2; Object </a>
115
+
116
+
117
+
118
+ </span>
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+
131
+ <span class="summary_desc"><div class='inline'>
132
+ <p>Returns the value of attribute logger.</p>
133
+ </div></span>
134
+
135
+ </li>
136
+
137
+
138
+ <li class="public ">
139
+ <span class="summary_signature">
140
+
141
+ <a href="#message-instance_method" title="#message (instance method)">#<strong>message</strong> &#x21d2; Object </a>
142
+
143
+
144
+
145
+ </span>
146
+
147
+
148
+
149
+
150
+
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+ <span class="summary_desc"><div class='inline'>
159
+ <p>Returns the value of attribute message.</p>
160
+ </div></span>
161
+
162
+ </li>
163
+
164
+
165
+ </ul>
166
+
167
+
168
+
169
+
170
+
171
+
172
+ <div id="instance_attr_details" class="attr_details">
173
+ <h2>Instance Attribute Details</h2>
174
+
175
+
176
+ <span id="logger=-instance_method"></span>
177
+ <div class="method_details first">
178
+ <h3 class="signature first" id="logger-instance_method">
179
+
180
+ #<strong>logger</strong> &#x21d2; <tt>Object</tt>
181
+
182
+
183
+
184
+
185
+
186
+ </h3><div class="docstring">
187
+ <div class="discussion">
188
+
189
+ <p>Returns the value of attribute logger</p>
190
+
191
+
192
+ </div>
193
+ </div>
194
+ <div class="tags">
195
+
196
+ <p class="tag_title">Returns:</p>
197
+ <ul class="return">
198
+
199
+ <li>
200
+
201
+
202
+ <span class='type'>(<tt>Object</tt>)</span>
203
+
204
+
205
+
206
+ &mdash;
207
+ <div class='inline'>
208
+ <p>the current value of logger</p>
209
+ </div>
210
+
211
+ </li>
212
+
213
+ </ul>
214
+
215
+ </div><table class="source_code">
216
+ <tr>
217
+ <td>
218
+ <pre class="lines">
219
+
220
+
221
+ 10
222
+ 11
223
+ 12</pre>
224
+ </td>
225
+ <td>
226
+ <pre class="code"><span class="info file"># File 'lib/outboxer/publisher.rb', line 10</span>
227
+
228
+ <span class='kw'>def</span> <span class='id identifier rubyid_logger'>logger</span>
229
+ <span class='ivar'>@logger</span>
230
+ <span class='kw'>end</span></pre>
231
+ </td>
232
+ </tr>
233
+ </table>
234
+ </div>
235
+
236
+
237
+ <span id="message=-instance_method"></span>
238
+ <div class="method_details ">
239
+ <h3 class="signature " id="message-instance_method">
240
+
241
+ #<strong>message</strong> &#x21d2; <tt>Object</tt>
242
+
243
+
244
+
245
+
246
+
247
+ </h3><div class="docstring">
248
+ <div class="discussion">
249
+
250
+ <p>Returns the value of attribute message</p>
251
+
252
+
253
+ </div>
254
+ </div>
255
+ <div class="tags">
256
+
257
+ <p class="tag_title">Returns:</p>
258
+ <ul class="return">
259
+
260
+ <li>
261
+
262
+
263
+ <span class='type'>(<tt>Object</tt>)</span>
264
+
265
+
266
+
267
+ &mdash;
268
+ <div class='inline'>
269
+ <p>the current value of message</p>
270
+ </div>
271
+
272
+ </li>
273
+
274
+ </ul>
275
+
276
+ </div><table class="source_code">
277
+ <tr>
278
+ <td>
279
+ <pre class="lines">
280
+
281
+
282
+ 10
283
+ 11
284
+ 12</pre>
285
+ </td>
286
+ <td>
287
+ <pre class="code"><span class="info file"># File 'lib/outboxer/publisher.rb', line 10</span>
288
+
289
+ <span class='kw'>def</span> <span class='id identifier rubyid_message'>message</span>
290
+ <span class='ivar'>@message</span>
291
+ <span class='kw'>end</span></pre>
292
+ </td>
293
+ </tr>
294
+ </table>
295
+ </div>
296
+
297
+ </div>
298
+
299
+
300
+ </div>
301
+
302
+ <div id="footer">
303
+ Generated on Sat Aug 5 04:37:46 2023 by
304
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
305
+ 0.9.34 (ruby-2.7.8).
306
+ </div>
307
+
308
+ </div>
309
+ </body>
310
+ </html>