docs/Ballast/RequestDomainMatcher.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Class: Ballast::RequestDomainMatcher
— Documentation by YARD 0.8.7.6
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
hasFrames = window.top.frames.main ? true : false;
relpath = '../';
framesUrl = "../frames.html#!Ballast/RequestDomainMatcher.html";
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div id="header">
<div id="menu">
<a href="../_index.html">Index (R)</a> »
<span class='title'><span class='object_link'><a href="../Ballast.html" title="Ballast (module)">Ballast</a></span></span>
»
<span class="title">RequestDomainMatcher</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
Class List
</a>
<a class="full_list_link" id="method_list_link"
href="../method_list.html">
Method List
</a>
<a class="full_list_link" id="file_list_link"
href="../file_list.html">
File List
</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Class: Ballast::RequestDomainMatcher
</h1>
<dl class="box">
<dt class="r1">Inherits:</dt>
<dd class="r1">
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Ballast::RequestDomainMatcher</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/ballast/request_domain_matcher.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>A small class to match requests basing on the domain.</p>
</div>
</div>
<div class="tags">
</div>
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#domains-instance_method" title="#domains (instance method)">- (Array) <strong>domains</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>The list of domains which mark a positive match.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#replace_block-instance_method" title="#replace_block (instance method)">- (Proc) <strong>replace_block</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>A block to use to manipulate the request host before trying the match.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#replace_pattern-instance_method" title="#replace_pattern (instance method)">- (String|Regexp) <strong>replace_pattern</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>A optional pattern to manipulate the request host before trying the match.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#replace_string-instance_method" title="#replace_string (instance method)">- (String) <strong>replace_string</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>A string to manipulate the request host before trying the match.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">- (RequestDomainMatcher) <strong>initialize</strong>(domains, replace_pattern = /\.dev$/, replace_string = "", &replace_block) </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>Creates a new matcher.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#matches%3F-instance_method" title="#matches? (instance method)">- (Boolean) <strong>matches?</strong>(request) </a>
</span>
<span class="summary_desc"><div class='inline'><p>Matches a request.</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
- (<tt><span class='object_link'><a href="" title="Ballast::RequestDomainMatcher (class)">RequestDomainMatcher</a></span></tt>) <strong>initialize</strong>(domains, replace_pattern = /\.dev$/, replace_string = "", &replace_block)
</h3><div class="docstring">
<div class="discussion">
<p>Creates a new matcher.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>domains</span>
<span class='type'>(<tt>String|Array</tt>)</span>
—
<div class='inline'><p>The list of domains which mark a positive match.</p>
</div>
</li>
<li>
<span class='name'>replace_pattern</span>
<span class='type'>(<tt>String|Regexp</tt>)</span>
<em class="default">(defaults to: <tt>/\.dev$/</tt>)</em>
—
<div class='inline'><p>A optional pattern to manipulate the request host before trying the match. See <code>String#gsub</code>.</p>
</div>
</li>
<li>
<span class='name'>replace_string</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>""</tt>)</em>
—
<div class='inline'><p>A string to manipulate the request host before trying the match. See <code>String#gsub</code>.</p>
</div>
</li>
<li>
<span class='name'>replace_block</span>
<span class='type'>(<tt>Proc</tt>)</span>
—
<div class='inline'><p>A block to use to manipulate the request host before trying the match. See <code>String#gsub</code>.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
26
27
28
29
30
31</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ballast/request_domain_matcher.rb', line 26</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'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_replace_block'>replace_block</span><span class='rparen'>)</span>
<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>
<span class='ivar'>@replace_pattern</span> <span class='op'>=</span> <span class='id identifier rubyid_replace_pattern'>replace_pattern</span>
<span class='ivar'>@replace_string</span> <span class='op'>=</span> <span class='id identifier rubyid_replace_string'>replace_string</span>
<span class='ivar'>@replace_block</span> <span class='op'>=</span> <span class='id identifier rubyid_replace_block'>replace_block</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id="domains=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="domains-instance_method">
- (<tt>Array</tt>) <strong>domains</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns The list of domains which mark a positive match.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array</tt>)</span>
—
<div class='inline'><p>The list of domains which mark a positive match.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ballast/request_domain_matcher.rb', line 17</span>
<span class='kw'>class</span> <span class='const'>RequestDomainMatcher</span>
<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>
<span class='comment'># Creates a new matcher.
</span> <span class='comment'>#
</span> <span class='comment'># @param domains [String|Array] The list of domains which mark a positive match.
</span> <span class='comment'># @param replace_pattern [String|Regexp] A optional pattern to manipulate the request host before trying the match. See `String#gsub`.
</span> <span class='comment'># @param replace_string [String] A string to manipulate the request host before trying the match. See `String#gsub`.
</span> <span class='comment'># @param replace_block [Proc] A block to use to manipulate the request host before trying the match. See `String#gsub`.
</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'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_replace_block'>replace_block</span><span class='rparen'>)</span>
<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>
<span class='ivar'>@replace_pattern</span> <span class='op'>=</span> <span class='id identifier rubyid_replace_pattern'>replace_pattern</span>
<span class='ivar'>@replace_string</span> <span class='op'>=</span> <span class='id identifier rubyid_replace_string'>replace_string</span>
<span class='ivar'>@replace_block</span> <span class='op'>=</span> <span class='id identifier rubyid_replace_block'>replace_block</span>
<span class='kw'>end</span>
<span class='comment'># Matches a request.
</span> <span class='comment'>#
</span> <span class='comment'># @param request [ActionDispatch::Request] The request to match.
</span> <span class='comment'># @return [Boolean] `true` if the request matches, `false` otherwise.
</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>
<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'>&</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>
<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>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="replace_block=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="replace_block-instance_method">
- (<tt>Proc</tt>) <strong>replace_block</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns A block to use to manipulate the request host before trying the match. See <code>String#gsub</code>.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Proc</tt>)</span>
—
<div class='inline'><p>A block to use to manipulate the request host before trying the match. See <code>String#gsub</code>.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ballast/request_domain_matcher.rb', line 17</span>
<span class='kw'>class</span> <span class='const'>RequestDomainMatcher</span>
<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>
<span class='comment'># Creates a new matcher.
</span> <span class='comment'>#
</span> <span class='comment'># @param domains [String|Array] The list of domains which mark a positive match.
</span> <span class='comment'># @param replace_pattern [String|Regexp] A optional pattern to manipulate the request host before trying the match. See `String#gsub`.
</span> <span class='comment'># @param replace_string [String] A string to manipulate the request host before trying the match. See `String#gsub`.
</span> <span class='comment'># @param replace_block [Proc] A block to use to manipulate the request host before trying the match. See `String#gsub`.
</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'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_replace_block'>replace_block</span><span class='rparen'>)</span>
<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>
<span class='ivar'>@replace_pattern</span> <span class='op'>=</span> <span class='id identifier rubyid_replace_pattern'>replace_pattern</span>
<span class='ivar'>@replace_string</span> <span class='op'>=</span> <span class='id identifier rubyid_replace_string'>replace_string</span>
<span class='ivar'>@replace_block</span> <span class='op'>=</span> <span class='id identifier rubyid_replace_block'>replace_block</span>
<span class='kw'>end</span>
<span class='comment'># Matches a request.
</span> <span class='comment'>#
</span> <span class='comment'># @param request [ActionDispatch::Request] The request to match.
</span> <span class='comment'># @return [Boolean] `true` if the request matches, `false` otherwise.
</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>
<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'>&</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>
<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>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="replace_pattern=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="replace_pattern-instance_method">
- (<tt>String|Regexp</tt>) <strong>replace_pattern</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns A optional pattern to manipulate the request host before trying the match. See <code>String#gsub</code>.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String|Regexp</tt>)</span>
—
<div class='inline'><p>A optional pattern to manipulate the request host before trying the match. See <code>String#gsub</code>.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ballast/request_domain_matcher.rb', line 17</span>
<span class='kw'>class</span> <span class='const'>RequestDomainMatcher</span>
<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>
<span class='comment'># Creates a new matcher.
</span> <span class='comment'>#
</span> <span class='comment'># @param domains [String|Array] The list of domains which mark a positive match.
</span> <span class='comment'># @param replace_pattern [String|Regexp] A optional pattern to manipulate the request host before trying the match. See `String#gsub`.
</span> <span class='comment'># @param replace_string [String] A string to manipulate the request host before trying the match. See `String#gsub`.
</span> <span class='comment'># @param replace_block [Proc] A block to use to manipulate the request host before trying the match. See `String#gsub`.
</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'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_replace_block'>replace_block</span><span class='rparen'>)</span>
<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>
<span class='ivar'>@replace_pattern</span> <span class='op'>=</span> <span class='id identifier rubyid_replace_pattern'>replace_pattern</span>
<span class='ivar'>@replace_string</span> <span class='op'>=</span> <span class='id identifier rubyid_replace_string'>replace_string</span>
<span class='ivar'>@replace_block</span> <span class='op'>=</span> <span class='id identifier rubyid_replace_block'>replace_block</span>
<span class='kw'>end</span>
<span class='comment'># Matches a request.
</span> <span class='comment'>#
</span> <span class='comment'># @param request [ActionDispatch::Request] The request to match.
</span> <span class='comment'># @return [Boolean] `true` if the request matches, `false` otherwise.
</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>
<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'>&</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>
<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>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="replace_string=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="replace_string-instance_method">
- (<tt>String</tt>) <strong>replace_string</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns A string to manipulate the request host before trying the match. See <code>String#gsub</code>.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>A string to manipulate the request host before trying the match. See <code>String#gsub</code>.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ballast/request_domain_matcher.rb', line 17</span>
<span class='kw'>class</span> <span class='const'>RequestDomainMatcher</span>
<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>
<span class='comment'># Creates a new matcher.
</span> <span class='comment'>#
</span> <span class='comment'># @param domains [String|Array] The list of domains which mark a positive match.
</span> <span class='comment'># @param replace_pattern [String|Regexp] A optional pattern to manipulate the request host before trying the match. See `String#gsub`.
</span> <span class='comment'># @param replace_string [String] A string to manipulate the request host before trying the match. See `String#gsub`.
</span> <span class='comment'># @param replace_block [Proc] A block to use to manipulate the request host before trying the match. See `String#gsub`.
</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'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_replace_block'>replace_block</span><span class='rparen'>)</span>
<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>
<span class='ivar'>@replace_pattern</span> <span class='op'>=</span> <span class='id identifier rubyid_replace_pattern'>replace_pattern</span>
<span class='ivar'>@replace_string</span> <span class='op'>=</span> <span class='id identifier rubyid_replace_string'>replace_string</span>
<span class='ivar'>@replace_block</span> <span class='op'>=</span> <span class='id identifier rubyid_replace_block'>replace_block</span>
<span class='kw'>end</span>
<span class='comment'># Matches a request.
</span> <span class='comment'>#
</span> <span class='comment'># @param request [ActionDispatch::Request] The request to match.
</span> <span class='comment'># @return [Boolean] `true` if the request matches, `false` otherwise.
</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>
<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'>&</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>
<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>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="matches?-instance_method">
- (<tt>Boolean</tt>) <strong>matches?</strong>(request)
</h3><div class="docstring">
<div class="discussion">
<p>Matches a request.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>request</span>
<span class='type'>(<tt>ActionDispatch::Request</tt>)</span>
—
<div class='inline'><p>The request to match.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Boolean</tt>)</span>
—
<div class='inline'><p><code>true</code> if the request matches, <code>false</code> otherwise.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
37
38
39
40</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/ballast/request_domain_matcher.rb', line 37</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>
<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'>&</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>
<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>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Thu Aug 18 15:49:49 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0).
</div>
</body>
</html>