ballast 2.2.4 → 2.2.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
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
@@ -116,7 +116,7 @@
116
116
  </div>
117
117
 
118
118
  <div id="footer">
119
- Generated on Tue Mar 29 10:52:51 2016 by
119
+ Generated on Thu Aug 18 15:49:48 2016 by
120
120
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
121
121
  0.8.7.6 (ruby-2.3.0).
122
122
  </div>
@@ -249,11 +249,10 @@
249
249
  <td>
250
250
  <pre class="code"><span class="info file"># File 'lib/ballast/errors.rb', line 19</span>
251
251
 
252
- <span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='rubyid_details identifier id'>details</span> <span class='assign token'>=</span> <span class='rubyid_nil nil kw'>nil</span><span class='rparen token'>)</span>
253
- <span class='rubyid_super super kw'>super</span><span class='lparen token'>(</span><span class='string val'>&quot;&quot;</span><span class='rparen token'>)</span>
254
- <span class='rubyid_@details ivar id'>@details</span> <span class='assign token'>=</span> <span class='rubyid_details identifier id'>details</span>
255
- <span class='rubyid_end end kw'>end</span>
256
- </pre>
252
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_details'>details</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
253
+ <span class='kw'>super</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
254
+ <span class='ivar'>@details</span> <span class='op'>=</span> <span class='id identifier rubyid_details'>details</span>
255
+ <span class='kw'>end</span></pre>
257
256
  </td>
258
257
  </tr>
259
258
  </table>
@@ -323,18 +322,17 @@
323
322
  <td>
324
323
  <pre class="code"><span class="info file"># File 'lib/ballast/errors.rb', line 13</span>
325
324
 
326
- <span class='rubyid_class class kw'>class</span> <span class='rubyid_Base constant id'>Base</span> <span class='lt op'>&lt;</span> <span class='rubyid_RuntimeError constant id'>RuntimeError</span>
327
- <span class='rubyid_attr_reader identifier id'>attr_reader</span> <span class='symbol val'>:details</span>
328
-
329
- <span class='comment val'># Creates a new error.</span>
330
- <span class='comment val'>#</span>
331
- <span class='comment val'># @param details [String|Hash|NilClass] The details of this error.</span>
332
- <span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='rubyid_details identifier id'>details</span> <span class='assign token'>=</span> <span class='rubyid_nil nil kw'>nil</span><span class='rparen token'>)</span>
333
- <span class='rubyid_super super kw'>super</span><span class='lparen token'>(</span><span class='string val'>&quot;&quot;</span><span class='rparen token'>)</span>
334
- <span class='rubyid_@details ivar id'>@details</span> <span class='assign token'>=</span> <span class='rubyid_details identifier id'>details</span>
335
- <span class='rubyid_end end kw'>end</span>
336
- <span class='rubyid_end end kw'>end</span>
337
- </pre>
325
+ <span class='kw'>class</span> <span class='const'>Base</span> <span class='op'>&lt;</span> <span class='const'>RuntimeError</span>
326
+ <span class='id identifier rubyid_attr_reader'>attr_reader</span> <span class='symbol'>:details</span>
327
+
328
+ <span class='comment'># Creates a new error.
329
+ </span> <span class='comment'>#
330
+ </span> <span class='comment'># @param details [String|Hash|NilClass] The details of this error.
331
+ </span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_details'>details</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
332
+ <span class='kw'>super</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
333
+ <span class='ivar'>@details</span> <span class='op'>=</span> <span class='id identifier rubyid_details'>details</span>
334
+ <span class='kw'>end</span>
335
+ <span class='kw'>end</span></pre>
338
336
  </td>
339
337
  </tr>
340
338
  </table>
@@ -346,7 +344,7 @@
346
344
  </div>
347
345
 
348
346
  <div id="footer">
349
- Generated on Tue Mar 29 10:52:51 2016 by
347
+ Generated on Thu Aug 18 15:49:49 2016 by
350
348
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
351
349
  0.8.7.6 (ruby-2.3.0).
352
350
  </div>
@@ -152,7 +152,7 @@
152
152
  </div>
153
153
 
154
154
  <div id="footer">
155
- Generated on Tue Mar 29 10:52:51 2016 by
155
+ Generated on Thu Aug 18 15:49:49 2016 by
156
156
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
157
157
  0.8.7.6 (ruby-2.3.0).
158
158
  </div>
@@ -148,7 +148,7 @@
148
148
  </div>
149
149
 
150
150
  <div id="footer">
151
- Generated on Tue Mar 29 10:52:51 2016 by
151
+ Generated on Thu Aug 18 15:49:49 2016 by
152
152
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
153
153
  0.8.7.6 (ruby-2.3.0).
154
154
  </div>
@@ -156,7 +156,7 @@
156
156
  </div>
157
157
 
158
158
  <div id="footer">
159
- Generated on Tue Mar 29 10:52:51 2016 by
159
+ Generated on Thu Aug 18 15:49:49 2016 by
160
160
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
161
161
  0.8.7.6 (ruby-2.3.0).
162
162
  </div>
@@ -116,7 +116,7 @@
116
116
  </div>
117
117
 
118
118
  <div id="footer">
119
- Generated on Tue Mar 29 10:52:51 2016 by
119
+ Generated on Thu Aug 18 15:49:48 2016 by
120
120
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
121
121
  0.8.7.6 (ruby-2.3.0).
122
122
  </div>
@@ -245,11 +245,10 @@
245
245
  <td>
246
246
  <pre class="code"><span class="info file"># File 'lib/ballast/middlewares/default_host.rb', line 15</span>
247
247
 
248
- <span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='rubyid_app identifier id'>app</span><span class='comma token'>,</span> <span class='rubyid_path identifier id'>path</span><span class='rparen token'>)</span>
249
- <span class='rubyid_@app ivar id'>@app</span> <span class='assign token'>=</span> <span class='rubyid_app identifier id'>app</span>
250
- <span class='rubyid_@hosts ivar id'>@hosts</span> <span class='assign token'>=</span> <span class='rubyid_YAML constant id'>YAML</span><span class='dot token'>.</span><span class='rubyid_load_file identifier id'>load_file</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='rparen token'>)</span>
251
- <span class='rubyid_end end kw'>end</span>
252
- </pre>
248
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_app'>app</span><span class='comma'>,</span> <span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
249
+ <span class='ivar'>@app</span> <span class='op'>=</span> <span class='id identifier rubyid_app'>app</span>
250
+ <span class='ivar'>@hosts</span> <span class='op'>=</span> <span class='const'>YAML</span><span class='period'>.</span><span class='id identifier rubyid_load_file'>load_file</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
251
+ <span class='kw'>end</span></pre>
253
252
  </td>
254
253
  </tr>
255
254
  </table>
@@ -323,20 +322,19 @@
323
322
  <td>
324
323
  <pre class="code"><span class="info file"># File 'lib/ballast/middlewares/default_host.rb', line 23</span>
325
324
 
326
- <span class='rubyid_def def kw'>def</span> <span class='rubyid_call identifier id'>call</span><span class='lparen token'>(</span><span class='rubyid_env identifier id'>env</span><span class='rparen token'>)</span>
327
- <span class='rubyid_old_host identifier id'>old_host</span> <span class='assign token'>=</span> <span class='rubyid_env identifier id'>env</span><span class='lbrack token'>[</span><span class='string val'>&quot;SERVER_NAME&quot;</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_ensure_string identifier id'>ensure_string</span>
328
- <span class='rubyid_new_host identifier id'>new_host</span> <span class='assign token'>=</span> <span class='rubyid_@hosts ivar id'>@hosts</span><span class='lbrack token'>[</span><span class='rubyid_ENV constant id'>ENV</span><span class='dot token'>.</span><span class='rubyid_fetch identifier id'>fetch</span><span class='lparen token'>(</span><span class='string val'>&quot;RACK_ENV&quot;</span><span class='comma token'>,</span> <span class='string val'>&quot;production&quot;</span><span class='rparen token'>)</span><span class='rbrack token'>]</span>
325
+ <span class='kw'>def</span> <span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_env'>env</span><span class='rparen'>)</span>
326
+ <span class='id identifier rubyid_old_host'>old_host</span> <span class='op'>=</span> <span class='id identifier rubyid_env'>env</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>SERVER_NAME</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_ensure_string'>ensure_string</span>
327
+ <span class='id identifier rubyid_new_host'>new_host</span> <span class='op'>=</span> <span class='ivar'>@hosts</span><span class='lbracket'>[</span><span class='const'>ENV</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>RACK_ENV</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>production</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rbracket'>]</span>
329
328
 
330
- <span class='rubyid_if if kw'>if</span> <span class='rubyid_old_host identifier id'>old_host</span> <span class='match op'>=~</span> <span class='regexp val'>/^\d/</span> <span class='andop op'>&amp;&amp;</span> <span class='rubyid_new_host identifier id'>new_host</span>
331
- <span class='rubyid_env identifier id'>env</span><span class='lbrack token'>[</span><span class='string val'>&quot;ORIG_SERVER_NAME&quot;</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='rubyid_old_host identifier id'>old_host</span>
332
- <span class='rubyid_env identifier id'>env</span><span class='lbrack token'>[</span><span class='string val'>&quot;ORIG_HTTP_HOST&quot;</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='rubyid_env identifier id'>env</span><span class='lbrack token'>[</span><span class='string val'>&quot;HTTP_HOST&quot;</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_dup identifier id'>dup</span>
333
- <span class='rubyid_env identifier id'>env</span><span class='lbrack token'>[</span><span class='string val'>&quot;SERVER_NAME&quot;</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='rubyid_new_host identifier id'>new_host</span>
334
- <span class='rubyid_env identifier id'>env</span><span class='lbrack token'>[</span><span class='string val'>&quot;HTTP_HOST&quot;</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_gsub! fid id'>gsub!</span><span class='lparen token'>(</span><span class='rubyid_old_host identifier id'>old_host</span><span class='comma token'>,</span> <span class='rubyid_new_host identifier id'>new_host</span><span class='rparen token'>)</span>
335
- <span class='rubyid_end end kw'>end</span>
329
+ <span class='kw'>if</span> <span class='id identifier rubyid_old_host'>old_host</span> <span class='op'>=~</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^\d</span><span class='regexp_end'>/</span></span> <span class='op'>&amp;&amp;</span> <span class='id identifier rubyid_new_host'>new_host</span>
330
+ <span class='id identifier rubyid_env'>env</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>ORIG_SERVER_NAME</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_old_host'>old_host</span>
331
+ <span class='id identifier rubyid_env'>env</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>ORIG_HTTP_HOST</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_env'>env</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>HTTP_HOST</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span>
332
+ <span class='id identifier rubyid_env'>env</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>SERVER_NAME</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_new_host'>new_host</span>
333
+ <span class='id identifier rubyid_env'>env</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>HTTP_HOST</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_gsub!'>gsub!</span><span class='lparen'>(</span><span class='id identifier rubyid_old_host'>old_host</span><span class='comma'>,</span> <span class='id identifier rubyid_new_host'>new_host</span><span class='rparen'>)</span>
334
+ <span class='kw'>end</span>
336
335
 
337
- <span class='rubyid_@app ivar id'>@app</span><span class='dot token'>.</span><span class='rubyid_call identifier id'>call</span><span class='lparen token'>(</span><span class='rubyid_env identifier id'>env</span><span class='rparen token'>)</span>
338
- <span class='rubyid_end end kw'>end</span>
339
- </pre>
336
+ <span class='ivar'>@app</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_env'>env</span><span class='rparen'>)</span>
337
+ <span class='kw'>end</span></pre>
340
338
  </td>
341
339
  </tr>
342
340
  </table>
@@ -347,7 +345,7 @@
347
345
  </div>
348
346
 
349
347
  <div id="footer">
350
- Generated on Tue Mar 29 10:52:51 2016 by
348
+ Generated on Thu Aug 18 15:49:49 2016 by
351
349
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
352
350
  0.8.7.6 (ruby-2.3.0).
353
351
  </div>
@@ -0,0 +1,917 @@
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='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_domains'>domains</span><span class='comma'>,</span> <span class='id identifier rubyid_replace_pattern'>replace_pattern</span> <span class='op'>=</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\.dev$</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='id identifier rubyid_replace_string'>replace_string</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_replace_block'>replace_block</span><span class='rparen'>)</span>
394
+ <span class='ivar'>@domains</span> <span class='op'>=</span> <span class='id identifier rubyid_domains'>domains</span><span class='period'>.</span><span class='id identifier rubyid_ensure_array'>ensure_array</span>
395
+ <span class='ivar'>@replace_pattern</span> <span class='op'>=</span> <span class='id identifier rubyid_replace_pattern'>replace_pattern</span>
396
+ <span class='ivar'>@replace_string</span> <span class='op'>=</span> <span class='id identifier rubyid_replace_string'>replace_string</span>
397
+ <span class='ivar'>@replace_block</span> <span class='op'>=</span> <span class='id identifier rubyid_replace_block'>replace_block</span>
398
+ <span class='kw'>end</span></pre>
399
+ </td>
400
+ </tr>
401
+ </table>
402
+ </div>
403
+
404
+ </div>
405
+
406
+ <div id="instance_attr_details" class="attr_details">
407
+ <h2>Instance Attribute Details</h2>
408
+
409
+
410
+ <span id="domains=-instance_method"></span>
411
+ <div class="method_details first">
412
+ <h3 class="signature first" id="domains-instance_method">
413
+
414
+ - (<tt>Array</tt>) <strong>domains</strong>
415
+
416
+
417
+
418
+
419
+
420
+ </h3><div class="docstring">
421
+ <div class="discussion">
422
+ <p>Returns The list of domains which mark a positive match.</p>
423
+
424
+
425
+ </div>
426
+ </div>
427
+ <div class="tags">
428
+
429
+ <p class="tag_title">Returns:</p>
430
+ <ul class="return">
431
+
432
+ <li>
433
+
434
+
435
+ <span class='type'>(<tt>Array</tt>)</span>
436
+
437
+
438
+
439
+ &mdash;
440
+ <div class='inline'><p>The list of domains which mark a positive match.</p>
441
+ </div>
442
+
443
+ </li>
444
+
445
+ </ul>
446
+
447
+ </div><table class="source_code">
448
+ <tr>
449
+ <td>
450
+ <pre class="lines">
451
+
452
+
453
+ 17
454
+ 18
455
+ 19
456
+ 20
457
+ 21
458
+ 22
459
+ 23
460
+ 24
461
+ 25
462
+ 26
463
+ 27
464
+ 28
465
+ 29
466
+ 30
467
+ 31
468
+ 32
469
+ 33
470
+ 34
471
+ 35
472
+ 36
473
+ 37
474
+ 38
475
+ 39
476
+ 40
477
+ 41</pre>
478
+ </td>
479
+ <td>
480
+ <pre class="code"><span class="info file"># File 'lib/ballast/request_domain_matcher.rb', line 17</span>
481
+
482
+ <span class='kw'>class</span> <span class='const'>RequestDomainMatcher</span>
483
+ <span class='id identifier rubyid_attr_accessor'>attr_accessor</span> <span class='symbol'>:domains</span><span class='comma'>,</span> <span class='symbol'>:replace_pattern</span><span class='comma'>,</span> <span class='symbol'>:replace_string</span><span class='comma'>,</span> <span class='symbol'>:replace_block</span>
484
+
485
+ <span class='comment'># Creates a new matcher.
486
+ </span> <span class='comment'>#
487
+ </span> <span class='comment'># @param domains [String|Array] The list of domains which mark a positive match.
488
+ </span> <span class='comment'># @param replace_pattern [String|Regexp] A optional pattern to manipulate the request host before trying the match. See `String#gsub`.
489
+ </span> <span class='comment'># @param replace_string [String] A string to manipulate the request host before trying the match. See `String#gsub`.
490
+ </span> <span class='comment'># @param replace_block [Proc] A block to use to manipulate the request host before trying the match. See `String#gsub`.
491
+ </span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_domains'>domains</span><span class='comma'>,</span> <span class='id identifier rubyid_replace_pattern'>replace_pattern</span> <span class='op'>=</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\.dev$</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='id identifier rubyid_replace_string'>replace_string</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_replace_block'>replace_block</span><span class='rparen'>)</span>
492
+ <span class='ivar'>@domains</span> <span class='op'>=</span> <span class='id identifier rubyid_domains'>domains</span><span class='period'>.</span><span class='id identifier rubyid_ensure_array'>ensure_array</span>
493
+ <span class='ivar'>@replace_pattern</span> <span class='op'>=</span> <span class='id identifier rubyid_replace_pattern'>replace_pattern</span>
494
+ <span class='ivar'>@replace_string</span> <span class='op'>=</span> <span class='id identifier rubyid_replace_string'>replace_string</span>
495
+ <span class='ivar'>@replace_block</span> <span class='op'>=</span> <span class='id identifier rubyid_replace_block'>replace_block</span>
496
+ <span class='kw'>end</span>
497
+
498
+ <span class='comment'># Matches a request.
499
+ </span> <span class='comment'>#
500
+ </span> <span class='comment'># @param request [ActionDispatch::Request] The request to match.
501
+ </span> <span class='comment'># @return [Boolean] `true` if the request matches, `false` otherwise.
502
+ </span> <span class='kw'>def</span> <span class='id identifier rubyid_matches?'>matches?</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='rparen'>)</span>
503
+ <span class='id identifier rubyid_final_host'>final_host</span> <span class='op'>=</span> <span class='ivar'>@replace_block</span> <span class='op'>?</span> <span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_host'>host</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='ivar'>@replace_pattern</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='ivar'>@replace_block</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_host'>host</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='ivar'>@replace_pattern</span><span class='comma'>,</span> <span class='ivar'>@replace_string</span><span class='rparen'>)</span>
504
+ <span class='ivar'>@domains</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_final_host'>final_host</span><span class='rparen'>)</span>
505
+ <span class='kw'>end</span>
506
+ <span class='kw'>end</span></pre>
507
+ </td>
508
+ </tr>
509
+ </table>
510
+ </div>
511
+
512
+
513
+ <span id="replace_block=-instance_method"></span>
514
+ <div class="method_details ">
515
+ <h3 class="signature " id="replace_block-instance_method">
516
+
517
+ - (<tt>Proc</tt>) <strong>replace_block</strong>
518
+
519
+
520
+
521
+
522
+
523
+ </h3><div class="docstring">
524
+ <div class="discussion">
525
+ <p>Returns A block to use to manipulate the request host before trying the match. See <code>String#gsub</code>.</p>
526
+
527
+
528
+ </div>
529
+ </div>
530
+ <div class="tags">
531
+
532
+ <p class="tag_title">Returns:</p>
533
+ <ul class="return">
534
+
535
+ <li>
536
+
537
+
538
+ <span class='type'>(<tt>Proc</tt>)</span>
539
+
540
+
541
+
542
+ &mdash;
543
+ <div class='inline'><p>A block to use to manipulate the request host before trying the match. See <code>String#gsub</code>.</p>
544
+ </div>
545
+
546
+ </li>
547
+
548
+ </ul>
549
+
550
+ </div><table class="source_code">
551
+ <tr>
552
+ <td>
553
+ <pre class="lines">
554
+
555
+
556
+ 17
557
+ 18
558
+ 19
559
+ 20
560
+ 21
561
+ 22
562
+ 23
563
+ 24
564
+ 25
565
+ 26
566
+ 27
567
+ 28
568
+ 29
569
+ 30
570
+ 31
571
+ 32
572
+ 33
573
+ 34
574
+ 35
575
+ 36
576
+ 37
577
+ 38
578
+ 39
579
+ 40
580
+ 41</pre>
581
+ </td>
582
+ <td>
583
+ <pre class="code"><span class="info file"># File 'lib/ballast/request_domain_matcher.rb', line 17</span>
584
+
585
+ <span class='kw'>class</span> <span class='const'>RequestDomainMatcher</span>
586
+ <span class='id identifier rubyid_attr_accessor'>attr_accessor</span> <span class='symbol'>:domains</span><span class='comma'>,</span> <span class='symbol'>:replace_pattern</span><span class='comma'>,</span> <span class='symbol'>:replace_string</span><span class='comma'>,</span> <span class='symbol'>:replace_block</span>
587
+
588
+ <span class='comment'># Creates a new matcher.
589
+ </span> <span class='comment'>#
590
+ </span> <span class='comment'># @param domains [String|Array] The list of domains which mark a positive match.
591
+ </span> <span class='comment'># @param replace_pattern [String|Regexp] A optional pattern to manipulate the request host before trying the match. See `String#gsub`.
592
+ </span> <span class='comment'># @param replace_string [String] A string to manipulate the request host before trying the match. See `String#gsub`.
593
+ </span> <span class='comment'># @param replace_block [Proc] A block to use to manipulate the request host before trying the match. See `String#gsub`.
594
+ </span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_domains'>domains</span><span class='comma'>,</span> <span class='id identifier rubyid_replace_pattern'>replace_pattern</span> <span class='op'>=</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\.dev$</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='id identifier rubyid_replace_string'>replace_string</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_replace_block'>replace_block</span><span class='rparen'>)</span>
595
+ <span class='ivar'>@domains</span> <span class='op'>=</span> <span class='id identifier rubyid_domains'>domains</span><span class='period'>.</span><span class='id identifier rubyid_ensure_array'>ensure_array</span>
596
+ <span class='ivar'>@replace_pattern</span> <span class='op'>=</span> <span class='id identifier rubyid_replace_pattern'>replace_pattern</span>
597
+ <span class='ivar'>@replace_string</span> <span class='op'>=</span> <span class='id identifier rubyid_replace_string'>replace_string</span>
598
+ <span class='ivar'>@replace_block</span> <span class='op'>=</span> <span class='id identifier rubyid_replace_block'>replace_block</span>
599
+ <span class='kw'>end</span>
600
+
601
+ <span class='comment'># Matches a request.
602
+ </span> <span class='comment'>#
603
+ </span> <span class='comment'># @param request [ActionDispatch::Request] The request to match.
604
+ </span> <span class='comment'># @return [Boolean] `true` if the request matches, `false` otherwise.
605
+ </span> <span class='kw'>def</span> <span class='id identifier rubyid_matches?'>matches?</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='rparen'>)</span>
606
+ <span class='id identifier rubyid_final_host'>final_host</span> <span class='op'>=</span> <span class='ivar'>@replace_block</span> <span class='op'>?</span> <span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_host'>host</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='ivar'>@replace_pattern</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='ivar'>@replace_block</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_host'>host</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='ivar'>@replace_pattern</span><span class='comma'>,</span> <span class='ivar'>@replace_string</span><span class='rparen'>)</span>
607
+ <span class='ivar'>@domains</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_final_host'>final_host</span><span class='rparen'>)</span>
608
+ <span class='kw'>end</span>
609
+ <span class='kw'>end</span></pre>
610
+ </td>
611
+ </tr>
612
+ </table>
613
+ </div>
614
+
615
+
616
+ <span id="replace_pattern=-instance_method"></span>
617
+ <div class="method_details ">
618
+ <h3 class="signature " id="replace_pattern-instance_method">
619
+
620
+ - (<tt>String|Regexp</tt>) <strong>replace_pattern</strong>
621
+
622
+
623
+
624
+
625
+
626
+ </h3><div class="docstring">
627
+ <div class="discussion">
628
+ <p>Returns A optional pattern to manipulate the request host before trying the match. See <code>String#gsub</code>.</p>
629
+
630
+
631
+ </div>
632
+ </div>
633
+ <div class="tags">
634
+
635
+ <p class="tag_title">Returns:</p>
636
+ <ul class="return">
637
+
638
+ <li>
639
+
640
+
641
+ <span class='type'>(<tt>String|Regexp</tt>)</span>
642
+
643
+
644
+
645
+ &mdash;
646
+ <div class='inline'><p>A optional pattern to manipulate the request host before trying the match. See <code>String#gsub</code>.</p>
647
+ </div>
648
+
649
+ </li>
650
+
651
+ </ul>
652
+
653
+ </div><table class="source_code">
654
+ <tr>
655
+ <td>
656
+ <pre class="lines">
657
+
658
+
659
+ 17
660
+ 18
661
+ 19
662
+ 20
663
+ 21
664
+ 22
665
+ 23
666
+ 24
667
+ 25
668
+ 26
669
+ 27
670
+ 28
671
+ 29
672
+ 30
673
+ 31
674
+ 32
675
+ 33
676
+ 34
677
+ 35
678
+ 36
679
+ 37
680
+ 38
681
+ 39
682
+ 40
683
+ 41</pre>
684
+ </td>
685
+ <td>
686
+ <pre class="code"><span class="info file"># File 'lib/ballast/request_domain_matcher.rb', line 17</span>
687
+
688
+ <span class='kw'>class</span> <span class='const'>RequestDomainMatcher</span>
689
+ <span class='id identifier rubyid_attr_accessor'>attr_accessor</span> <span class='symbol'>:domains</span><span class='comma'>,</span> <span class='symbol'>:replace_pattern</span><span class='comma'>,</span> <span class='symbol'>:replace_string</span><span class='comma'>,</span> <span class='symbol'>:replace_block</span>
690
+
691
+ <span class='comment'># Creates a new matcher.
692
+ </span> <span class='comment'>#
693
+ </span> <span class='comment'># @param domains [String|Array] The list of domains which mark a positive match.
694
+ </span> <span class='comment'># @param replace_pattern [String|Regexp] A optional pattern to manipulate the request host before trying the match. See `String#gsub`.
695
+ </span> <span class='comment'># @param replace_string [String] A string to manipulate the request host before trying the match. See `String#gsub`.
696
+ </span> <span class='comment'># @param replace_block [Proc] A block to use to manipulate the request host before trying the match. See `String#gsub`.
697
+ </span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_domains'>domains</span><span class='comma'>,</span> <span class='id identifier rubyid_replace_pattern'>replace_pattern</span> <span class='op'>=</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\.dev$</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='id identifier rubyid_replace_string'>replace_string</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_replace_block'>replace_block</span><span class='rparen'>)</span>
698
+ <span class='ivar'>@domains</span> <span class='op'>=</span> <span class='id identifier rubyid_domains'>domains</span><span class='period'>.</span><span class='id identifier rubyid_ensure_array'>ensure_array</span>
699
+ <span class='ivar'>@replace_pattern</span> <span class='op'>=</span> <span class='id identifier rubyid_replace_pattern'>replace_pattern</span>
700
+ <span class='ivar'>@replace_string</span> <span class='op'>=</span> <span class='id identifier rubyid_replace_string'>replace_string</span>
701
+ <span class='ivar'>@replace_block</span> <span class='op'>=</span> <span class='id identifier rubyid_replace_block'>replace_block</span>
702
+ <span class='kw'>end</span>
703
+
704
+ <span class='comment'># Matches a request.
705
+ </span> <span class='comment'>#
706
+ </span> <span class='comment'># @param request [ActionDispatch::Request] The request to match.
707
+ </span> <span class='comment'># @return [Boolean] `true` if the request matches, `false` otherwise.
708
+ </span> <span class='kw'>def</span> <span class='id identifier rubyid_matches?'>matches?</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='rparen'>)</span>
709
+ <span class='id identifier rubyid_final_host'>final_host</span> <span class='op'>=</span> <span class='ivar'>@replace_block</span> <span class='op'>?</span> <span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_host'>host</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='ivar'>@replace_pattern</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='ivar'>@replace_block</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_host'>host</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='ivar'>@replace_pattern</span><span class='comma'>,</span> <span class='ivar'>@replace_string</span><span class='rparen'>)</span>
710
+ <span class='ivar'>@domains</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_final_host'>final_host</span><span class='rparen'>)</span>
711
+ <span class='kw'>end</span>
712
+ <span class='kw'>end</span></pre>
713
+ </td>
714
+ </tr>
715
+ </table>
716
+ </div>
717
+
718
+
719
+ <span id="replace_string=-instance_method"></span>
720
+ <div class="method_details ">
721
+ <h3 class="signature " id="replace_string-instance_method">
722
+
723
+ - (<tt>String</tt>) <strong>replace_string</strong>
724
+
725
+
726
+
727
+
728
+
729
+ </h3><div class="docstring">
730
+ <div class="discussion">
731
+ <p>Returns A string to manipulate the request host before trying the match. See <code>String#gsub</code>.</p>
732
+
733
+
734
+ </div>
735
+ </div>
736
+ <div class="tags">
737
+
738
+ <p class="tag_title">Returns:</p>
739
+ <ul class="return">
740
+
741
+ <li>
742
+
743
+
744
+ <span class='type'>(<tt>String</tt>)</span>
745
+
746
+
747
+
748
+ &mdash;
749
+ <div class='inline'><p>A string to manipulate the request host before trying the match. See <code>String#gsub</code>.</p>
750
+ </div>
751
+
752
+ </li>
753
+
754
+ </ul>
755
+
756
+ </div><table class="source_code">
757
+ <tr>
758
+ <td>
759
+ <pre class="lines">
760
+
761
+
762
+ 17
763
+ 18
764
+ 19
765
+ 20
766
+ 21
767
+ 22
768
+ 23
769
+ 24
770
+ 25
771
+ 26
772
+ 27
773
+ 28
774
+ 29
775
+ 30
776
+ 31
777
+ 32
778
+ 33
779
+ 34
780
+ 35
781
+ 36
782
+ 37
783
+ 38
784
+ 39
785
+ 40
786
+ 41</pre>
787
+ </td>
788
+ <td>
789
+ <pre class="code"><span class="info file"># File 'lib/ballast/request_domain_matcher.rb', line 17</span>
790
+
791
+ <span class='kw'>class</span> <span class='const'>RequestDomainMatcher</span>
792
+ <span class='id identifier rubyid_attr_accessor'>attr_accessor</span> <span class='symbol'>:domains</span><span class='comma'>,</span> <span class='symbol'>:replace_pattern</span><span class='comma'>,</span> <span class='symbol'>:replace_string</span><span class='comma'>,</span> <span class='symbol'>:replace_block</span>
793
+
794
+ <span class='comment'># Creates a new matcher.
795
+ </span> <span class='comment'>#
796
+ </span> <span class='comment'># @param domains [String|Array] The list of domains which mark a positive match.
797
+ </span> <span class='comment'># @param replace_pattern [String|Regexp] A optional pattern to manipulate the request host before trying the match. See `String#gsub`.
798
+ </span> <span class='comment'># @param replace_string [String] A string to manipulate the request host before trying the match. See `String#gsub`.
799
+ </span> <span class='comment'># @param replace_block [Proc] A block to use to manipulate the request host before trying the match. See `String#gsub`.
800
+ </span> <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_domains'>domains</span><span class='comma'>,</span> <span class='id identifier rubyid_replace_pattern'>replace_pattern</span> <span class='op'>=</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>\.dev$</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='id identifier rubyid_replace_string'>replace_string</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='id identifier rubyid_replace_block'>replace_block</span><span class='rparen'>)</span>
801
+ <span class='ivar'>@domains</span> <span class='op'>=</span> <span class='id identifier rubyid_domains'>domains</span><span class='period'>.</span><span class='id identifier rubyid_ensure_array'>ensure_array</span>
802
+ <span class='ivar'>@replace_pattern</span> <span class='op'>=</span> <span class='id identifier rubyid_replace_pattern'>replace_pattern</span>
803
+ <span class='ivar'>@replace_string</span> <span class='op'>=</span> <span class='id identifier rubyid_replace_string'>replace_string</span>
804
+ <span class='ivar'>@replace_block</span> <span class='op'>=</span> <span class='id identifier rubyid_replace_block'>replace_block</span>
805
+ <span class='kw'>end</span>
806
+
807
+ <span class='comment'># Matches a request.
808
+ </span> <span class='comment'>#
809
+ </span> <span class='comment'># @param request [ActionDispatch::Request] The request to match.
810
+ </span> <span class='comment'># @return [Boolean] `true` if the request matches, `false` otherwise.
811
+ </span> <span class='kw'>def</span> <span class='id identifier rubyid_matches?'>matches?</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='rparen'>)</span>
812
+ <span class='id identifier rubyid_final_host'>final_host</span> <span class='op'>=</span> <span class='ivar'>@replace_block</span> <span class='op'>?</span> <span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_host'>host</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='ivar'>@replace_pattern</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='ivar'>@replace_block</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_host'>host</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='ivar'>@replace_pattern</span><span class='comma'>,</span> <span class='ivar'>@replace_string</span><span class='rparen'>)</span>
813
+ <span class='ivar'>@domains</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_final_host'>final_host</span><span class='rparen'>)</span>
814
+ <span class='kw'>end</span>
815
+ <span class='kw'>end</span></pre>
816
+ </td>
817
+ </tr>
818
+ </table>
819
+ </div>
820
+
821
+ </div>
822
+
823
+
824
+ <div id="instance_method_details" class="method_details_list">
825
+ <h2>Instance Method Details</h2>
826
+
827
+
828
+ <div class="method_details first">
829
+ <h3 class="signature first" id="matches?-instance_method">
830
+
831
+ - (<tt>Boolean</tt>) <strong>matches?</strong>(request)
832
+
833
+
834
+
835
+
836
+
837
+ </h3><div class="docstring">
838
+ <div class="discussion">
839
+ <p>Matches a request.</p>
840
+
841
+
842
+ </div>
843
+ </div>
844
+ <div class="tags">
845
+ <p class="tag_title">Parameters:</p>
846
+ <ul class="param">
847
+
848
+ <li>
849
+
850
+ <span class='name'>request</span>
851
+
852
+
853
+ <span class='type'>(<tt>ActionDispatch::Request</tt>)</span>
854
+
855
+
856
+
857
+ &mdash;
858
+ <div class='inline'><p>The request to match.</p>
859
+ </div>
860
+
861
+ </li>
862
+
863
+ </ul>
864
+
865
+ <p class="tag_title">Returns:</p>
866
+ <ul class="return">
867
+
868
+ <li>
869
+
870
+
871
+ <span class='type'>(<tt>Boolean</tt>)</span>
872
+
873
+
874
+
875
+ &mdash;
876
+ <div class='inline'><p><code>true</code> if the request matches, <code>false</code> otherwise.</p>
877
+ </div>
878
+
879
+ </li>
880
+
881
+ </ul>
882
+
883
+ </div><table class="source_code">
884
+ <tr>
885
+ <td>
886
+ <pre class="lines">
887
+
888
+
889
+ 37
890
+ 38
891
+ 39
892
+ 40</pre>
893
+ </td>
894
+ <td>
895
+ <pre class="code"><span class="info file"># File 'lib/ballast/request_domain_matcher.rb', line 37</span>
896
+
897
+ <span class='kw'>def</span> <span class='id identifier rubyid_matches?'>matches?</span><span class='lparen'>(</span><span class='id identifier rubyid_request'>request</span><span class='rparen'>)</span>
898
+ <span class='id identifier rubyid_final_host'>final_host</span> <span class='op'>=</span> <span class='ivar'>@replace_block</span> <span class='op'>?</span> <span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_host'>host</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='ivar'>@replace_pattern</span><span class='comma'>,</span> <span class='op'>&amp;</span><span class='ivar'>@replace_block</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='id identifier rubyid_request'>request</span><span class='period'>.</span><span class='id identifier rubyid_host'>host</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='ivar'>@replace_pattern</span><span class='comma'>,</span> <span class='ivar'>@replace_string</span><span class='rparen'>)</span>
899
+ <span class='ivar'>@domains</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_final_host'>final_host</span><span class='rparen'>)</span>
900
+ <span class='kw'>end</span></pre>
901
+ </td>
902
+ </tr>
903
+ </table>
904
+ </div>
905
+
906
+ </div>
907
+
908
+ </div>
909
+
910
+ <div id="footer">
911
+ Generated on Thu Aug 18 15:49:49 2016 by
912
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
913
+ 0.8.7.6 (ruby-2.3.0).
914
+ </div>
915
+
916
+ </body>
917
+ </html>