ballast 2.2.4 → 2.2.5

Sign up to get free protection for your applications and to get access to all the features.
Files changed (86) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +6 -1
  3. data/.travis-gemfile +2 -2
  4. data/.travis.yml +5 -3
  5. data/.yardopts +1 -1
  6. data/CHANGELOG.md +9 -0
  7. data/Gemfile +1 -1
  8. data/LICENSE.md +21 -0
  9. data/README.md +22 -17
  10. data/Rakefile +1 -1
  11. data/ballast.gemspec +1 -1
  12. data/{doc → docs}/Ballast.html +19 -21
  13. data/docs/Ballast/AjaxResponse.html +1470 -0
  14. data/{doc → docs}/Ballast/Concerns.html +3 -3
  15. data/{doc → docs}/Ballast/Concerns/AjaxHandling.html +33 -38
  16. data/{doc → docs}/Ballast/Concerns/Common.html +45 -52
  17. data/{doc → docs}/Ballast/Concerns/ErrorsHandling.html +13 -14
  18. data/docs/Ballast/Concerns/JSONApi.html +127 -0
  19. data/docs/Ballast/Concerns/JSONApi/PaginationHandling.html +617 -0
  20. data/docs/Ballast/Concerns/JSONApi/RequestHandling.html +775 -0
  21. data/docs/Ballast/Concerns/JSONApi/ResponseHandling.html +917 -0
  22. data/{doc → docs}/Ballast/Concerns/View.html +35 -42
  23. data/{doc → docs}/Ballast/Configuration.html +19 -22
  24. data/{doc → docs}/Ballast/Emoji.html +1 -1
  25. data/{doc → docs}/Ballast/Emoji/Character.html +15 -18
  26. data/docs/Ballast/Emoji/Utils.html +794 -0
  27. data/{doc → docs}/Ballast/Errors.html +1 -1
  28. data/{doc → docs}/Ballast/Errors/Base.html +16 -18
  29. data/{doc → docs}/Ballast/Errors/Failure.html +1 -1
  30. data/{doc → docs}/Ballast/Errors/InvalidDomain.html +1 -1
  31. data/{doc → docs}/Ballast/Errors/ValidationFailure.html +1 -1
  32. data/{doc → docs}/Ballast/Middlewares.html +1 -1
  33. data/{doc → docs}/Ballast/Middlewares/DefaultHost.html +16 -18
  34. data/docs/Ballast/RequestDomainMatcher.html +917 -0
  35. data/docs/Ballast/Service.html +1513 -0
  36. data/docs/Ballast/Service/Response.html +1270 -0
  37. data/{doc → docs}/Ballast/Version.html +5 -9
  38. data/{doc → docs}/_index.html +45 -1
  39. data/docs/class_list.html +58 -0
  40. data/{doc → docs}/css/common.css +0 -0
  41. data/{doc → docs}/css/full_list.css +0 -0
  42. data/{doc → docs}/css/style.css +0 -0
  43. data/{doc → docs}/file.README.html +7 -5
  44. data/{doc → docs}/file_list.html +0 -0
  45. data/{doc → docs}/frames.html +0 -0
  46. data/{doc → docs}/index.html +7 -5
  47. data/{doc → docs}/js/app.js +0 -0
  48. data/{doc → docs}/js/full_list.js +0 -0
  49. data/{doc → docs}/js/jquery.js +0 -0
  50. data/{doc → docs}/method_list.html +150 -36
  51. data/docs/top-level-namespace.html +149 -0
  52. data/lib/ballast.rb +1 -1
  53. data/lib/ballast/ajax_response.rb +1 -1
  54. data/lib/ballast/concerns/ajax_handling.rb +1 -1
  55. data/lib/ballast/concerns/common.rb +1 -1
  56. data/lib/ballast/concerns/errors_handling.rb +1 -1
  57. data/lib/ballast/concerns/json_api/pagination_handling.rb +83 -0
  58. data/lib/ballast/concerns/json_api/request_handling.rb +235 -0
  59. data/lib/ballast/concerns/json_api/response_handling.rb +70 -0
  60. data/lib/ballast/concerns/view.rb +1 -1
  61. data/lib/ballast/configuration.rb +1 -1
  62. data/lib/ballast/emoji.rb +1 -1
  63. data/lib/ballast/errors.rb +1 -1
  64. data/lib/ballast/middlewares/default_host.rb +1 -1
  65. data/lib/ballast/request_domain_matcher.rb +1 -1
  66. data/lib/ballast/service.rb +1 -1
  67. data/lib/ballast/version.rb +2 -2
  68. data/spec/ballast/ajax_response_spec.rb +1 -1
  69. data/spec/ballast/concerns/ajax_handling_spec.rb +1 -1
  70. data/spec/ballast/concerns/common_spec.rb +1 -1
  71. data/spec/ballast/concerns/errors_handling_spec.rb +1 -1
  72. data/spec/ballast/concerns/view_spec.rb +1 -1
  73. data/spec/ballast/configuration_spec.rb +1 -1
  74. data/spec/ballast/errors_spec.rb +1 -1
  75. data/spec/ballast/middlewares/default_host_spec.rb +1 -1
  76. data/spec/ballast/request_domain_matcher_spec.rb +1 -1
  77. data/spec/ballast_spec.rb +1 -1
  78. data/spec/spec_helper.rb +1 -1
  79. metadata +47 -39
  80. data/doc/Ballast/AjaxResponse.html +0 -1478
  81. data/doc/Ballast/Emoji/Utils.html +0 -799
  82. data/doc/Ballast/RequestDomainMatcher.html +0 -923
  83. data/doc/Ballast/Service.html +0 -1522
  84. data/doc/Ballast/Service/Response.html +0 -1278
  85. data/doc/class_list.html +0 -58
  86. data/doc/top-level-namespace.html +0 -112
@@ -1,923 +0,0 @@
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: Ballast::RequestDomainMatcher
8
-
9
- &mdash; Documentation by YARD 0.8.7.6
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#!Ballast/RequestDomainMatcher.html";
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 (R)</a> &raquo;
35
- <span class='title'><span class='object_link'><a href="../Ballast.html" title="Ballast (module)">Ballast</a></span></span>
36
- &raquo;
37
- <span class="title">RequestDomainMatcher</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: Ballast::RequestDomainMatcher
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">Ballast::RequestDomainMatcher</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/ballast/request_domain_matcher.rb</dd>
98
-
99
- </dl>
100
- <div class="clear"></div>
101
-
102
- <h2>Overview</h2><div class="docstring">
103
- <div class="discussion">
104
- <p>A small class to match requests basing on the domain.</p>
105
-
106
-
107
- </div>
108
- </div>
109
- <div class="tags">
110
-
111
-
112
- </div>
113
-
114
-
115
-
116
- <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
117
- <ul class="summary">
118
-
119
- <li class="public ">
120
- <span class="summary_signature">
121
-
122
- <a href="#domains-instance_method" title="#domains (instance method)">- (Array) <strong>domains</strong> </a>
123
-
124
-
125
-
126
- </span>
127
-
128
-
129
-
130
-
131
-
132
-
133
-
134
-
135
-
136
-
137
-
138
-
139
- <span class="summary_desc"><div class='inline'><p>The list of domains which mark a positive match.</p>
140
- </div></span>
141
-
142
- </li>
143
-
144
-
145
- <li class="public ">
146
- <span class="summary_signature">
147
-
148
- <a href="#replace_block-instance_method" title="#replace_block (instance method)">- (Proc) <strong>replace_block</strong> </a>
149
-
150
-
151
-
152
- </span>
153
-
154
-
155
-
156
-
157
-
158
-
159
-
160
-
161
-
162
-
163
-
164
-
165
- <span class="summary_desc"><div class='inline'><p>A block to use to manipulate the request host before trying the match.</p>
166
- </div></span>
167
-
168
- </li>
169
-
170
-
171
- <li class="public ">
172
- <span class="summary_signature">
173
-
174
- <a href="#replace_pattern-instance_method" title="#replace_pattern (instance method)">- (String|Regexp) <strong>replace_pattern</strong> </a>
175
-
176
-
177
-
178
- </span>
179
-
180
-
181
-
182
-
183
-
184
-
185
-
186
-
187
-
188
-
189
-
190
-
191
- <span class="summary_desc"><div class='inline'><p>A optional pattern to manipulate the request host before trying the match.</p>
192
- </div></span>
193
-
194
- </li>
195
-
196
-
197
- <li class="public ">
198
- <span class="summary_signature">
199
-
200
- <a href="#replace_string-instance_method" title="#replace_string (instance method)">- (String) <strong>replace_string</strong> </a>
201
-
202
-
203
-
204
- </span>
205
-
206
-
207
-
208
-
209
-
210
-
211
-
212
-
213
-
214
-
215
-
216
-
217
- <span class="summary_desc"><div class='inline'><p>A string to manipulate the request host before trying the match.</p>
218
- </div></span>
219
-
220
- </li>
221
-
222
-
223
- </ul>
224
-
225
-
226
-
227
-
228
-
229
- <h2>
230
- Instance Method Summary
231
- <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
232
- </h2>
233
-
234
- <ul class="summary">
235
-
236
- <li class="public ">
237
- <span class="summary_signature">
238
-
239
- <a href="#initialize-instance_method" title="#initialize (instance method)">- (RequestDomainMatcher) <strong>initialize</strong>(domains, replace_pattern = /\.dev$/, replace_string = &quot;&quot;, &amp;replace_block) </a>
240
-
241
-
242
-
243
- </span>
244
-
245
-
246
- <span class="note title constructor">constructor</span>
247
-
248
-
249
-
250
-
251
-
252
-
253
-
254
-
255
- <span class="summary_desc"><div class='inline'><p>Creates a new matcher.</p>
256
- </div></span>
257
-
258
- </li>
259
-
260
-
261
- <li class="public ">
262
- <span class="summary_signature">
263
-
264
- <a href="#matches%3F-instance_method" title="#matches? (instance method)">- (Boolean) <strong>matches?</strong>(request) </a>
265
-
266
-
267
-
268
- </span>
269
-
270
-
271
-
272
-
273
-
274
-
275
-
276
-
277
-
278
- <span class="summary_desc"><div class='inline'><p>Matches a request.</p>
279
- </div></span>
280
-
281
- </li>
282
-
283
-
284
- </ul>
285
-
286
-
287
- <div id="constructor_details" class="method_details_list">
288
- <h2>Constructor Details</h2>
289
-
290
- <div class="method_details first">
291
- <h3 class="signature first" id="initialize-instance_method">
292
-
293
- - (<tt><span class='object_link'><a href="" title="Ballast::RequestDomainMatcher (class)">RequestDomainMatcher</a></span></tt>) <strong>initialize</strong>(domains, replace_pattern = /\.dev$/, replace_string = &quot;&quot;, &amp;replace_block)
294
-
295
-
296
-
297
-
298
-
299
- </h3><div class="docstring">
300
- <div class="discussion">
301
- <p>Creates a new matcher.</p>
302
-
303
-
304
- </div>
305
- </div>
306
- <div class="tags">
307
- <p class="tag_title">Parameters:</p>
308
- <ul class="param">
309
-
310
- <li>
311
-
312
- <span class='name'>domains</span>
313
-
314
-
315
- <span class='type'>(<tt>String|Array</tt>)</span>
316
-
317
-
318
-
319
- &mdash;
320
- <div class='inline'><p>The list of domains which mark a positive match.</p>
321
- </div>
322
-
323
- </li>
324
-
325
- <li>
326
-
327
- <span class='name'>replace_pattern</span>
328
-
329
-
330
- <span class='type'>(<tt>String|Regexp</tt>)</span>
331
-
332
-
333
- <em class="default">(defaults to: <tt>/\.dev$/</tt>)</em>
334
-
335
-
336
- &mdash;
337
- <div class='inline'><p>A optional pattern to manipulate the request host before trying the match. See <code>String#gsub</code>.</p>
338
- </div>
339
-
340
- </li>
341
-
342
- <li>
343
-
344
- <span class='name'>replace_string</span>
345
-
346
-
347
- <span class='type'>(<tt>String</tt>)</span>
348
-
349
-
350
- <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
351
-
352
-
353
- &mdash;
354
- <div class='inline'><p>A string to manipulate the request host before trying the match. See <code>String#gsub</code>.</p>
355
- </div>
356
-
357
- </li>
358
-
359
- <li>
360
-
361
- <span class='name'>replace_block</span>
362
-
363
-
364
- <span class='type'>(<tt>Proc</tt>)</span>
365
-
366
-
367
-
368
- &mdash;
369
- <div class='inline'><p>A block to use to manipulate the request host before trying the match. See <code>String#gsub</code>.</p>
370
- </div>
371
-
372
- </li>
373
-
374
- </ul>
375
-
376
-
377
- </div><table class="source_code">
378
- <tr>
379
- <td>
380
- <pre class="lines">
381
-
382
-
383
- 26
384
- 27
385
- 28
386
- 29
387
- 30
388
- 31</pre>
389
- </td>
390
- <td>
391
- <pre class="code"><span class="info file"># File 'lib/ballast/request_domain_matcher.rb', line 26</span>
392
-
393
- <span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='rubyid_domains identifier id'>domains</span><span class='comma token'>,</span> <span class='rubyid_replace_pattern identifier id'>replace_pattern</span> <span class='assign token'>=</span> <span class='regexp val'>/\.dev$/</span><span class='comma token'>,</span> <span class='rubyid_replace_string identifier id'>replace_string</span> <span class='assign token'>=</span> <span class='string val'>&quot;&quot;</span><span class='comma token'>,</span> <span class='bitand op'>&amp;</span><span class='rubyid_replace_block identifier id'>replace_block</span><span class='rparen token'>)</span>
394
- <span class='rubyid_@domains ivar id'>@domains</span> <span class='assign token'>=</span> <span class='rubyid_domains identifier id'>domains</span><span class='dot token'>.</span><span class='rubyid_ensure_array identifier id'>ensure_array</span>
395
- <span class='rubyid_@replace_pattern ivar id'>@replace_pattern</span> <span class='assign token'>=</span> <span class='rubyid_replace_pattern identifier id'>replace_pattern</span>
396
- <span class='rubyid_@replace_string ivar id'>@replace_string</span> <span class='assign token'>=</span> <span class='rubyid_replace_string identifier id'>replace_string</span>
397
- <span class='rubyid_@replace_block ivar id'>@replace_block</span> <span class='assign token'>=</span> <span class='rubyid_replace_block identifier id'>replace_block</span>
398
- <span class='rubyid_end end kw'>end</span>
399
- </pre>
400
- </td>
401
- </tr>
402
- </table>
403
- </div>
404
-
405
- </div>
406
-
407
- <div id="instance_attr_details" class="attr_details">
408
- <h2>Instance Attribute Details</h2>
409
-
410
-
411
- <span id="domains=-instance_method"></span>
412
- <div class="method_details first">
413
- <h3 class="signature first" id="domains-instance_method">
414
-
415
- - (<tt>Array</tt>) <strong>domains</strong>
416
-
417
-
418
-
419
-
420
-
421
- </h3><div class="docstring">
422
- <div class="discussion">
423
- <p>Returns The list of domains which mark a positive match.</p>
424
-
425
-
426
- </div>
427
- </div>
428
- <div class="tags">
429
-
430
- <p class="tag_title">Returns:</p>
431
- <ul class="return">
432
-
433
- <li>
434
-
435
-
436
- <span class='type'>(<tt>Array</tt>)</span>
437
-
438
-
439
-
440
- &mdash;
441
- <div class='inline'><p>The list of domains which mark a positive match.</p>
442
- </div>
443
-
444
- </li>
445
-
446
- </ul>
447
-
448
- </div><table class="source_code">
449
- <tr>
450
- <td>
451
- <pre class="lines">
452
-
453
-
454
- 17
455
- 18
456
- 19
457
- 20
458
- 21
459
- 22
460
- 23
461
- 24
462
- 25
463
- 26
464
- 27
465
- 28
466
- 29
467
- 30
468
- 31
469
- 32
470
- 33
471
- 34
472
- 35
473
- 36
474
- 37
475
- 38
476
- 39
477
- 40
478
- 41</pre>
479
- </td>
480
- <td>
481
- <pre class="code"><span class="info file"># File 'lib/ballast/request_domain_matcher.rb', line 17</span>
482
-
483
- <span class='rubyid_class class kw'>class</span> <span class='rubyid_RequestDomainMatcher constant id'>RequestDomainMatcher</span>
484
- <span class='rubyid_attr_accessor identifier id'>attr_accessor</span> <span class='symbol val'>:domains</span><span class='comma token'>,</span> <span class='symbol val'>:replace_pattern</span><span class='comma token'>,</span> <span class='symbol val'>:replace_string</span><span class='comma token'>,</span> <span class='symbol val'>:replace_block</span>
485
-
486
- <span class='comment val'># Creates a new matcher.</span>
487
- <span class='comment val'>#</span>
488
- <span class='comment val'># @param domains [String|Array] The list of domains which mark a positive match.</span>
489
- <span class='comment val'># @param replace_pattern [String|Regexp] A optional pattern to manipulate the request host before trying the match. See `String#gsub`.</span>
490
- <span class='comment val'># @param replace_string [String] A string to manipulate the request host before trying the match. See `String#gsub`.</span>
491
- <span class='comment val'># @param replace_block [Proc] A block to use to manipulate the request host before trying the match. See `String#gsub`.</span>
492
- <span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='rubyid_domains identifier id'>domains</span><span class='comma token'>,</span> <span class='rubyid_replace_pattern identifier id'>replace_pattern</span> <span class='assign token'>=</span> <span class='regexp val'>/\.dev$/</span><span class='comma token'>,</span> <span class='rubyid_replace_string identifier id'>replace_string</span> <span class='assign token'>=</span> <span class='string val'>&quot;&quot;</span><span class='comma token'>,</span> <span class='bitand op'>&amp;</span><span class='rubyid_replace_block identifier id'>replace_block</span><span class='rparen token'>)</span>
493
- <span class='rubyid_@domains ivar id'>@domains</span> <span class='assign token'>=</span> <span class='rubyid_domains identifier id'>domains</span><span class='dot token'>.</span><span class='rubyid_ensure_array identifier id'>ensure_array</span>
494
- <span class='rubyid_@replace_pattern ivar id'>@replace_pattern</span> <span class='assign token'>=</span> <span class='rubyid_replace_pattern identifier id'>replace_pattern</span>
495
- <span class='rubyid_@replace_string ivar id'>@replace_string</span> <span class='assign token'>=</span> <span class='rubyid_replace_string identifier id'>replace_string</span>
496
- <span class='rubyid_@replace_block ivar id'>@replace_block</span> <span class='assign token'>=</span> <span class='rubyid_replace_block identifier id'>replace_block</span>
497
- <span class='rubyid_end end kw'>end</span>
498
-
499
- <span class='comment val'># Matches a request.</span>
500
- <span class='comment val'>#</span>
501
- <span class='comment val'># @param request [ActionDispatch::Request] The request to match.</span>
502
- <span class='comment val'># @return [Boolean] `true` if the request matches, `false` otherwise.</span>
503
- <span class='rubyid_def def kw'>def</span> <span class='rubyid_matches? fid id'>matches?</span><span class='lparen token'>(</span><span class='rubyid_request identifier id'>request</span><span class='rparen token'>)</span>
504
- <span class='rubyid_final_host identifier id'>final_host</span> <span class='assign token'>=</span> <span class='rubyid_@replace_block ivar id'>@replace_block</span> <span class='question op'>?</span> <span class='rubyid_request identifier id'>request</span><span class='dot token'>.</span><span class='rubyid_host identifier id'>host</span><span class='dot token'>.</span><span class='rubyid_gsub identifier id'>gsub</span><span class='lparen token'>(</span><span class='rubyid_@replace_pattern ivar id'>@replace_pattern</span><span class='comma token'>,</span> <span class='bitand op'>&amp;</span><span class='rubyid_@replace_block ivar id'>@replace_block</span><span class='rparen token'>)</span> <span class='colon op'>:</span> <span class='rubyid_request identifier id'>request</span><span class='dot token'>.</span><span class='rubyid_host identifier id'>host</span><span class='dot token'>.</span><span class='rubyid_gsub identifier id'>gsub</span><span class='lparen token'>(</span><span class='rubyid_@replace_pattern ivar id'>@replace_pattern</span><span class='comma token'>,</span> <span class='rubyid_@replace_string ivar id'>@replace_string</span><span class='rparen token'>)</span>
505
- <span class='rubyid_@domains ivar id'>@domains</span><span class='dot token'>.</span><span class='rubyid_include? fid id'>include?</span><span class='lparen token'>(</span><span class='rubyid_final_host identifier id'>final_host</span><span class='rparen token'>)</span>
506
- <span class='rubyid_end end kw'>end</span>
507
- <span class='rubyid_end end kw'>end</span>
508
- </pre>
509
- </td>
510
- </tr>
511
- </table>
512
- </div>
513
-
514
-
515
- <span id="replace_block=-instance_method"></span>
516
- <div class="method_details ">
517
- <h3 class="signature " id="replace_block-instance_method">
518
-
519
- - (<tt>Proc</tt>) <strong>replace_block</strong>
520
-
521
-
522
-
523
-
524
-
525
- </h3><div class="docstring">
526
- <div class="discussion">
527
- <p>Returns A block to use to manipulate the request host before trying the match. See <code>String#gsub</code>.</p>
528
-
529
-
530
- </div>
531
- </div>
532
- <div class="tags">
533
-
534
- <p class="tag_title">Returns:</p>
535
- <ul class="return">
536
-
537
- <li>
538
-
539
-
540
- <span class='type'>(<tt>Proc</tt>)</span>
541
-
542
-
543
-
544
- &mdash;
545
- <div class='inline'><p>A block to use to manipulate the request host before trying the match. See <code>String#gsub</code>.</p>
546
- </div>
547
-
548
- </li>
549
-
550
- </ul>
551
-
552
- </div><table class="source_code">
553
- <tr>
554
- <td>
555
- <pre class="lines">
556
-
557
-
558
- 17
559
- 18
560
- 19
561
- 20
562
- 21
563
- 22
564
- 23
565
- 24
566
- 25
567
- 26
568
- 27
569
- 28
570
- 29
571
- 30
572
- 31
573
- 32
574
- 33
575
- 34
576
- 35
577
- 36
578
- 37
579
- 38
580
- 39
581
- 40
582
- 41</pre>
583
- </td>
584
- <td>
585
- <pre class="code"><span class="info file"># File 'lib/ballast/request_domain_matcher.rb', line 17</span>
586
-
587
- <span class='rubyid_class class kw'>class</span> <span class='rubyid_RequestDomainMatcher constant id'>RequestDomainMatcher</span>
588
- <span class='rubyid_attr_accessor identifier id'>attr_accessor</span> <span class='symbol val'>:domains</span><span class='comma token'>,</span> <span class='symbol val'>:replace_pattern</span><span class='comma token'>,</span> <span class='symbol val'>:replace_string</span><span class='comma token'>,</span> <span class='symbol val'>:replace_block</span>
589
-
590
- <span class='comment val'># Creates a new matcher.</span>
591
- <span class='comment val'>#</span>
592
- <span class='comment val'># @param domains [String|Array] The list of domains which mark a positive match.</span>
593
- <span class='comment val'># @param replace_pattern [String|Regexp] A optional pattern to manipulate the request host before trying the match. See `String#gsub`.</span>
594
- <span class='comment val'># @param replace_string [String] A string to manipulate the request host before trying the match. See `String#gsub`.</span>
595
- <span class='comment val'># @param replace_block [Proc] A block to use to manipulate the request host before trying the match. See `String#gsub`.</span>
596
- <span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='rubyid_domains identifier id'>domains</span><span class='comma token'>,</span> <span class='rubyid_replace_pattern identifier id'>replace_pattern</span> <span class='assign token'>=</span> <span class='regexp val'>/\.dev$/</span><span class='comma token'>,</span> <span class='rubyid_replace_string identifier id'>replace_string</span> <span class='assign token'>=</span> <span class='string val'>&quot;&quot;</span><span class='comma token'>,</span> <span class='bitand op'>&amp;</span><span class='rubyid_replace_block identifier id'>replace_block</span><span class='rparen token'>)</span>
597
- <span class='rubyid_@domains ivar id'>@domains</span> <span class='assign token'>=</span> <span class='rubyid_domains identifier id'>domains</span><span class='dot token'>.</span><span class='rubyid_ensure_array identifier id'>ensure_array</span>
598
- <span class='rubyid_@replace_pattern ivar id'>@replace_pattern</span> <span class='assign token'>=</span> <span class='rubyid_replace_pattern identifier id'>replace_pattern</span>
599
- <span class='rubyid_@replace_string ivar id'>@replace_string</span> <span class='assign token'>=</span> <span class='rubyid_replace_string identifier id'>replace_string</span>
600
- <span class='rubyid_@replace_block ivar id'>@replace_block</span> <span class='assign token'>=</span> <span class='rubyid_replace_block identifier id'>replace_block</span>
601
- <span class='rubyid_end end kw'>end</span>
602
-
603
- <span class='comment val'># Matches a request.</span>
604
- <span class='comment val'>#</span>
605
- <span class='comment val'># @param request [ActionDispatch::Request] The request to match.</span>
606
- <span class='comment val'># @return [Boolean] `true` if the request matches, `false` otherwise.</span>
607
- <span class='rubyid_def def kw'>def</span> <span class='rubyid_matches? fid id'>matches?</span><span class='lparen token'>(</span><span class='rubyid_request identifier id'>request</span><span class='rparen token'>)</span>
608
- <span class='rubyid_final_host identifier id'>final_host</span> <span class='assign token'>=</span> <span class='rubyid_@replace_block ivar id'>@replace_block</span> <span class='question op'>?</span> <span class='rubyid_request identifier id'>request</span><span class='dot token'>.</span><span class='rubyid_host identifier id'>host</span><span class='dot token'>.</span><span class='rubyid_gsub identifier id'>gsub</span><span class='lparen token'>(</span><span class='rubyid_@replace_pattern ivar id'>@replace_pattern</span><span class='comma token'>,</span> <span class='bitand op'>&amp;</span><span class='rubyid_@replace_block ivar id'>@replace_block</span><span class='rparen token'>)</span> <span class='colon op'>:</span> <span class='rubyid_request identifier id'>request</span><span class='dot token'>.</span><span class='rubyid_host identifier id'>host</span><span class='dot token'>.</span><span class='rubyid_gsub identifier id'>gsub</span><span class='lparen token'>(</span><span class='rubyid_@replace_pattern ivar id'>@replace_pattern</span><span class='comma token'>,</span> <span class='rubyid_@replace_string ivar id'>@replace_string</span><span class='rparen token'>)</span>
609
- <span class='rubyid_@domains ivar id'>@domains</span><span class='dot token'>.</span><span class='rubyid_include? fid id'>include?</span><span class='lparen token'>(</span><span class='rubyid_final_host identifier id'>final_host</span><span class='rparen token'>)</span>
610
- <span class='rubyid_end end kw'>end</span>
611
- <span class='rubyid_end end kw'>end</span>
612
- </pre>
613
- </td>
614
- </tr>
615
- </table>
616
- </div>
617
-
618
-
619
- <span id="replace_pattern=-instance_method"></span>
620
- <div class="method_details ">
621
- <h3 class="signature " id="replace_pattern-instance_method">
622
-
623
- - (<tt>String|Regexp</tt>) <strong>replace_pattern</strong>
624
-
625
-
626
-
627
-
628
-
629
- </h3><div class="docstring">
630
- <div class="discussion">
631
- <p>Returns A optional pattern to manipulate the request host before trying the match. See <code>String#gsub</code>.</p>
632
-
633
-
634
- </div>
635
- </div>
636
- <div class="tags">
637
-
638
- <p class="tag_title">Returns:</p>
639
- <ul class="return">
640
-
641
- <li>
642
-
643
-
644
- <span class='type'>(<tt>String|Regexp</tt>)</span>
645
-
646
-
647
-
648
- &mdash;
649
- <div class='inline'><p>A optional pattern to manipulate the request host before trying the match. See <code>String#gsub</code>.</p>
650
- </div>
651
-
652
- </li>
653
-
654
- </ul>
655
-
656
- </div><table class="source_code">
657
- <tr>
658
- <td>
659
- <pre class="lines">
660
-
661
-
662
- 17
663
- 18
664
- 19
665
- 20
666
- 21
667
- 22
668
- 23
669
- 24
670
- 25
671
- 26
672
- 27
673
- 28
674
- 29
675
- 30
676
- 31
677
- 32
678
- 33
679
- 34
680
- 35
681
- 36
682
- 37
683
- 38
684
- 39
685
- 40
686
- 41</pre>
687
- </td>
688
- <td>
689
- <pre class="code"><span class="info file"># File 'lib/ballast/request_domain_matcher.rb', line 17</span>
690
-
691
- <span class='rubyid_class class kw'>class</span> <span class='rubyid_RequestDomainMatcher constant id'>RequestDomainMatcher</span>
692
- <span class='rubyid_attr_accessor identifier id'>attr_accessor</span> <span class='symbol val'>:domains</span><span class='comma token'>,</span> <span class='symbol val'>:replace_pattern</span><span class='comma token'>,</span> <span class='symbol val'>:replace_string</span><span class='comma token'>,</span> <span class='symbol val'>:replace_block</span>
693
-
694
- <span class='comment val'># Creates a new matcher.</span>
695
- <span class='comment val'>#</span>
696
- <span class='comment val'># @param domains [String|Array] The list of domains which mark a positive match.</span>
697
- <span class='comment val'># @param replace_pattern [String|Regexp] A optional pattern to manipulate the request host before trying the match. See `String#gsub`.</span>
698
- <span class='comment val'># @param replace_string [String] A string to manipulate the request host before trying the match. See `String#gsub`.</span>
699
- <span class='comment val'># @param replace_block [Proc] A block to use to manipulate the request host before trying the match. See `String#gsub`.</span>
700
- <span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='rubyid_domains identifier id'>domains</span><span class='comma token'>,</span> <span class='rubyid_replace_pattern identifier id'>replace_pattern</span> <span class='assign token'>=</span> <span class='regexp val'>/\.dev$/</span><span class='comma token'>,</span> <span class='rubyid_replace_string identifier id'>replace_string</span> <span class='assign token'>=</span> <span class='string val'>&quot;&quot;</span><span class='comma token'>,</span> <span class='bitand op'>&amp;</span><span class='rubyid_replace_block identifier id'>replace_block</span><span class='rparen token'>)</span>
701
- <span class='rubyid_@domains ivar id'>@domains</span> <span class='assign token'>=</span> <span class='rubyid_domains identifier id'>domains</span><span class='dot token'>.</span><span class='rubyid_ensure_array identifier id'>ensure_array</span>
702
- <span class='rubyid_@replace_pattern ivar id'>@replace_pattern</span> <span class='assign token'>=</span> <span class='rubyid_replace_pattern identifier id'>replace_pattern</span>
703
- <span class='rubyid_@replace_string ivar id'>@replace_string</span> <span class='assign token'>=</span> <span class='rubyid_replace_string identifier id'>replace_string</span>
704
- <span class='rubyid_@replace_block ivar id'>@replace_block</span> <span class='assign token'>=</span> <span class='rubyid_replace_block identifier id'>replace_block</span>
705
- <span class='rubyid_end end kw'>end</span>
706
-
707
- <span class='comment val'># Matches a request.</span>
708
- <span class='comment val'>#</span>
709
- <span class='comment val'># @param request [ActionDispatch::Request] The request to match.</span>
710
- <span class='comment val'># @return [Boolean] `true` if the request matches, `false` otherwise.</span>
711
- <span class='rubyid_def def kw'>def</span> <span class='rubyid_matches? fid id'>matches?</span><span class='lparen token'>(</span><span class='rubyid_request identifier id'>request</span><span class='rparen token'>)</span>
712
- <span class='rubyid_final_host identifier id'>final_host</span> <span class='assign token'>=</span> <span class='rubyid_@replace_block ivar id'>@replace_block</span> <span class='question op'>?</span> <span class='rubyid_request identifier id'>request</span><span class='dot token'>.</span><span class='rubyid_host identifier id'>host</span><span class='dot token'>.</span><span class='rubyid_gsub identifier id'>gsub</span><span class='lparen token'>(</span><span class='rubyid_@replace_pattern ivar id'>@replace_pattern</span><span class='comma token'>,</span> <span class='bitand op'>&amp;</span><span class='rubyid_@replace_block ivar id'>@replace_block</span><span class='rparen token'>)</span> <span class='colon op'>:</span> <span class='rubyid_request identifier id'>request</span><span class='dot token'>.</span><span class='rubyid_host identifier id'>host</span><span class='dot token'>.</span><span class='rubyid_gsub identifier id'>gsub</span><span class='lparen token'>(</span><span class='rubyid_@replace_pattern ivar id'>@replace_pattern</span><span class='comma token'>,</span> <span class='rubyid_@replace_string ivar id'>@replace_string</span><span class='rparen token'>)</span>
713
- <span class='rubyid_@domains ivar id'>@domains</span><span class='dot token'>.</span><span class='rubyid_include? fid id'>include?</span><span class='lparen token'>(</span><span class='rubyid_final_host identifier id'>final_host</span><span class='rparen token'>)</span>
714
- <span class='rubyid_end end kw'>end</span>
715
- <span class='rubyid_end end kw'>end</span>
716
- </pre>
717
- </td>
718
- </tr>
719
- </table>
720
- </div>
721
-
722
-
723
- <span id="replace_string=-instance_method"></span>
724
- <div class="method_details ">
725
- <h3 class="signature " id="replace_string-instance_method">
726
-
727
- - (<tt>String</tt>) <strong>replace_string</strong>
728
-
729
-
730
-
731
-
732
-
733
- </h3><div class="docstring">
734
- <div class="discussion">
735
- <p>Returns A string to manipulate the request host before trying the match. See <code>String#gsub</code>.</p>
736
-
737
-
738
- </div>
739
- </div>
740
- <div class="tags">
741
-
742
- <p class="tag_title">Returns:</p>
743
- <ul class="return">
744
-
745
- <li>
746
-
747
-
748
- <span class='type'>(<tt>String</tt>)</span>
749
-
750
-
751
-
752
- &mdash;
753
- <div class='inline'><p>A string to manipulate the request host before trying the match. See <code>String#gsub</code>.</p>
754
- </div>
755
-
756
- </li>
757
-
758
- </ul>
759
-
760
- </div><table class="source_code">
761
- <tr>
762
- <td>
763
- <pre class="lines">
764
-
765
-
766
- 17
767
- 18
768
- 19
769
- 20
770
- 21
771
- 22
772
- 23
773
- 24
774
- 25
775
- 26
776
- 27
777
- 28
778
- 29
779
- 30
780
- 31
781
- 32
782
- 33
783
- 34
784
- 35
785
- 36
786
- 37
787
- 38
788
- 39
789
- 40
790
- 41</pre>
791
- </td>
792
- <td>
793
- <pre class="code"><span class="info file"># File 'lib/ballast/request_domain_matcher.rb', line 17</span>
794
-
795
- <span class='rubyid_class class kw'>class</span> <span class='rubyid_RequestDomainMatcher constant id'>RequestDomainMatcher</span>
796
- <span class='rubyid_attr_accessor identifier id'>attr_accessor</span> <span class='symbol val'>:domains</span><span class='comma token'>,</span> <span class='symbol val'>:replace_pattern</span><span class='comma token'>,</span> <span class='symbol val'>:replace_string</span><span class='comma token'>,</span> <span class='symbol val'>:replace_block</span>
797
-
798
- <span class='comment val'># Creates a new matcher.</span>
799
- <span class='comment val'>#</span>
800
- <span class='comment val'># @param domains [String|Array] The list of domains which mark a positive match.</span>
801
- <span class='comment val'># @param replace_pattern [String|Regexp] A optional pattern to manipulate the request host before trying the match. See `String#gsub`.</span>
802
- <span class='comment val'># @param replace_string [String] A string to manipulate the request host before trying the match. See `String#gsub`.</span>
803
- <span class='comment val'># @param replace_block [Proc] A block to use to manipulate the request host before trying the match. See `String#gsub`.</span>
804
- <span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='rubyid_domains identifier id'>domains</span><span class='comma token'>,</span> <span class='rubyid_replace_pattern identifier id'>replace_pattern</span> <span class='assign token'>=</span> <span class='regexp val'>/\.dev$/</span><span class='comma token'>,</span> <span class='rubyid_replace_string identifier id'>replace_string</span> <span class='assign token'>=</span> <span class='string val'>&quot;&quot;</span><span class='comma token'>,</span> <span class='bitand op'>&amp;</span><span class='rubyid_replace_block identifier id'>replace_block</span><span class='rparen token'>)</span>
805
- <span class='rubyid_@domains ivar id'>@domains</span> <span class='assign token'>=</span> <span class='rubyid_domains identifier id'>domains</span><span class='dot token'>.</span><span class='rubyid_ensure_array identifier id'>ensure_array</span>
806
- <span class='rubyid_@replace_pattern ivar id'>@replace_pattern</span> <span class='assign token'>=</span> <span class='rubyid_replace_pattern identifier id'>replace_pattern</span>
807
- <span class='rubyid_@replace_string ivar id'>@replace_string</span> <span class='assign token'>=</span> <span class='rubyid_replace_string identifier id'>replace_string</span>
808
- <span class='rubyid_@replace_block ivar id'>@replace_block</span> <span class='assign token'>=</span> <span class='rubyid_replace_block identifier id'>replace_block</span>
809
- <span class='rubyid_end end kw'>end</span>
810
-
811
- <span class='comment val'># Matches a request.</span>
812
- <span class='comment val'>#</span>
813
- <span class='comment val'># @param request [ActionDispatch::Request] The request to match.</span>
814
- <span class='comment val'># @return [Boolean] `true` if the request matches, `false` otherwise.</span>
815
- <span class='rubyid_def def kw'>def</span> <span class='rubyid_matches? fid id'>matches?</span><span class='lparen token'>(</span><span class='rubyid_request identifier id'>request</span><span class='rparen token'>)</span>
816
- <span class='rubyid_final_host identifier id'>final_host</span> <span class='assign token'>=</span> <span class='rubyid_@replace_block ivar id'>@replace_block</span> <span class='question op'>?</span> <span class='rubyid_request identifier id'>request</span><span class='dot token'>.</span><span class='rubyid_host identifier id'>host</span><span class='dot token'>.</span><span class='rubyid_gsub identifier id'>gsub</span><span class='lparen token'>(</span><span class='rubyid_@replace_pattern ivar id'>@replace_pattern</span><span class='comma token'>,</span> <span class='bitand op'>&amp;</span><span class='rubyid_@replace_block ivar id'>@replace_block</span><span class='rparen token'>)</span> <span class='colon op'>:</span> <span class='rubyid_request identifier id'>request</span><span class='dot token'>.</span><span class='rubyid_host identifier id'>host</span><span class='dot token'>.</span><span class='rubyid_gsub identifier id'>gsub</span><span class='lparen token'>(</span><span class='rubyid_@replace_pattern ivar id'>@replace_pattern</span><span class='comma token'>,</span> <span class='rubyid_@replace_string ivar id'>@replace_string</span><span class='rparen token'>)</span>
817
- <span class='rubyid_@domains ivar id'>@domains</span><span class='dot token'>.</span><span class='rubyid_include? fid id'>include?</span><span class='lparen token'>(</span><span class='rubyid_final_host identifier id'>final_host</span><span class='rparen token'>)</span>
818
- <span class='rubyid_end end kw'>end</span>
819
- <span class='rubyid_end end kw'>end</span>
820
- </pre>
821
- </td>
822
- </tr>
823
- </table>
824
- </div>
825
-
826
- </div>
827
-
828
-
829
- <div id="instance_method_details" class="method_details_list">
830
- <h2>Instance Method Details</h2>
831
-
832
-
833
- <div class="method_details first">
834
- <h3 class="signature first" id="matches?-instance_method">
835
-
836
- - (<tt>Boolean</tt>) <strong>matches?</strong>(request)
837
-
838
-
839
-
840
-
841
-
842
- </h3><div class="docstring">
843
- <div class="discussion">
844
- <p>Matches a request.</p>
845
-
846
-
847
- </div>
848
- </div>
849
- <div class="tags">
850
- <p class="tag_title">Parameters:</p>
851
- <ul class="param">
852
-
853
- <li>
854
-
855
- <span class='name'>request</span>
856
-
857
-
858
- <span class='type'>(<tt>ActionDispatch::Request</tt>)</span>
859
-
860
-
861
-
862
- &mdash;
863
- <div class='inline'><p>The request to match.</p>
864
- </div>
865
-
866
- </li>
867
-
868
- </ul>
869
-
870
- <p class="tag_title">Returns:</p>
871
- <ul class="return">
872
-
873
- <li>
874
-
875
-
876
- <span class='type'>(<tt>Boolean</tt>)</span>
877
-
878
-
879
-
880
- &mdash;
881
- <div class='inline'><p><code>true</code> if the request matches, <code>false</code> otherwise.</p>
882
- </div>
883
-
884
- </li>
885
-
886
- </ul>
887
-
888
- </div><table class="source_code">
889
- <tr>
890
- <td>
891
- <pre class="lines">
892
-
893
-
894
- 37
895
- 38
896
- 39
897
- 40</pre>
898
- </td>
899
- <td>
900
- <pre class="code"><span class="info file"># File 'lib/ballast/request_domain_matcher.rb', line 37</span>
901
-
902
- <span class='rubyid_def def kw'>def</span> <span class='rubyid_matches? fid id'>matches?</span><span class='lparen token'>(</span><span class='rubyid_request identifier id'>request</span><span class='rparen token'>)</span>
903
- <span class='rubyid_final_host identifier id'>final_host</span> <span class='assign token'>=</span> <span class='rubyid_@replace_block ivar id'>@replace_block</span> <span class='question op'>?</span> <span class='rubyid_request identifier id'>request</span><span class='dot token'>.</span><span class='rubyid_host identifier id'>host</span><span class='dot token'>.</span><span class='rubyid_gsub identifier id'>gsub</span><span class='lparen token'>(</span><span class='rubyid_@replace_pattern ivar id'>@replace_pattern</span><span class='comma token'>,</span> <span class='bitand op'>&amp;</span><span class='rubyid_@replace_block ivar id'>@replace_block</span><span class='rparen token'>)</span> <span class='colon op'>:</span> <span class='rubyid_request identifier id'>request</span><span class='dot token'>.</span><span class='rubyid_host identifier id'>host</span><span class='dot token'>.</span><span class='rubyid_gsub identifier id'>gsub</span><span class='lparen token'>(</span><span class='rubyid_@replace_pattern ivar id'>@replace_pattern</span><span class='comma token'>,</span> <span class='rubyid_@replace_string ivar id'>@replace_string</span><span class='rparen token'>)</span>
904
- <span class='rubyid_@domains ivar id'>@domains</span><span class='dot token'>.</span><span class='rubyid_include? fid id'>include?</span><span class='lparen token'>(</span><span class='rubyid_final_host identifier id'>final_host</span><span class='rparen token'>)</span>
905
- <span class='rubyid_end end kw'>end</span>
906
- </pre>
907
- </td>
908
- </tr>
909
- </table>
910
- </div>
911
-
912
- </div>
913
-
914
- </div>
915
-
916
- <div id="footer">
917
- Generated on Tue Mar 29 10:52:51 2016 by
918
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
919
- 0.8.7.6 (ruby-2.3.0).
920
- </div>
921
-
922
- </body>
923
- </html>