doc/Ballast/RequestDomainMatcher.html in ballast-1.9.3 vs doc/Ballast/RequestDomainMatcher.html in ballast-2.0.0

- old
+ new

@@ -4,22 +4,22 @@ <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title> Class: Ballast::RequestDomainMatcher - &mdash; Documentation by YARD 0.8.7.3 + &mdash; 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#!" + escape(window.location.href); + framesUrl = "../frames.html#!Ballast/RequestDomainMatcher.html"; </script> <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> @@ -160,11 +160,11 @@ - <span class="summary_desc"><div class='inline'><p>A block to use for replacement in the request host.</p> + <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> @@ -186,11 +186,11 @@ - <span class="summary_desc"><div class='inline'><p>A optional pattern to replace in the request host.</p> + <span class="summary_desc"><div class='inline'><p>A optional pattern to manipulate the request host before trying the match.</p> </div></span> </li> @@ -212,11 +212,11 @@ - <span class="summary_desc"><div class='inline'><p>A string to use for replacement in the request host.</p> + <span class="summary_desc"><div class='inline'><p>A string to manipulate the request host before trying the match.</p> </div></span> </li> @@ -332,11 +332,11 @@ <em class="default">(defaults to: <tt>/\.dev$/</tt>)</em> &mdash; - <div class='inline'><p>A optional pattern to replace in the request host. See <code>String#gsub</code>.</p> + <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> @@ -349,11 +349,11 @@ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em> &mdash; - <div class='inline'><p>A string to use for replacement in the request host. See <code>String#gsub</code>.</p> + <div class='inline'><p>A string to manipulate the request host before trying the match. See <code>String#gsub</code>.</p> </div> </li> <li> @@ -364,11 +364,11 @@ <span class='type'>(<tt>Proc</tt>)</span> &mdash; - <div class='inline'><p>A block to use for replacement in the request host. See <code>String#gsub</code>.</p> + <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> @@ -483,13 +483,13 @@ <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 replace in the request host. See `String#gsub`. -</span> <span class='comment'># @param replace_string [String] A string to use for replacement in the request host. See `String#gsub`. -</span> <span class='comment'># @param replace_block [Proc] A block to use for replacement in the request host. See `String#gsub`. +</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'>&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> <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> @@ -520,11 +520,11 @@ </h3><div class="docstring"> <div class="discussion"> - <p>Returns A block to use for replacement in the request host. See <code>String#gsub</code>.</p> + <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"> @@ -538,11 +538,11 @@ <span class='type'>(<tt>Proc</tt>)</span> &mdash; - <div class='inline'><p>A block to use for replacement in the request host. See <code>String#gsub</code>.</p> + <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> @@ -586,13 +586,13 @@ <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 replace in the request host. See `String#gsub`. -</span> <span class='comment'># @param replace_string [String] A string to use for replacement in the request host. See `String#gsub`. -</span> <span class='comment'># @param replace_block [Proc] A block to use for replacement in the request host. See `String#gsub`. +</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'>&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> <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> @@ -623,11 +623,11 @@ </h3><div class="docstring"> <div class="discussion"> - <p>Returns A optional pattern to replace in the request host. See <code>String#gsub</code>.</p> + <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"> @@ -641,11 +641,11 @@ <span class='type'>(<tt>String|Regexp</tt>)</span> &mdash; - <div class='inline'><p>A optional pattern to replace in the request host. See <code>String#gsub</code>.</p> + <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> @@ -689,13 +689,13 @@ <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 replace in the request host. See `String#gsub`. -</span> <span class='comment'># @param replace_string [String] A string to use for replacement in the request host. See `String#gsub`. -</span> <span class='comment'># @param replace_block [Proc] A block to use for replacement in the request host. See `String#gsub`. +</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'>&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> <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> @@ -726,11 +726,11 @@ </h3><div class="docstring"> <div class="discussion"> - <p>Returns A string to use for replacement in the request host. See <code>String#gsub</code>.</p> + <p>Returns A string to manipulate the request host before trying the match. See <code>String#gsub</code>.</p> </div> </div> <div class="tags"> @@ -744,11 +744,11 @@ <span class='type'>(<tt>String</tt>)</span> &mdash; - <div class='inline'><p>A string to use for replacement in the request host. See <code>String#gsub</code>.</p> + <div class='inline'><p>A string to manipulate the request host before trying the match. See <code>String#gsub</code>.</p> </div> </li> </ul> @@ -792,13 +792,13 @@ <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 replace in the request host. See `String#gsub`. -</span> <span class='comment'># @param replace_string [String] A string to use for replacement in the request host. See `String#gsub`. -</span> <span class='comment'># @param replace_block [Proc] A block to use for replacement in the request host. See `String#gsub`. +</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'>&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> <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> @@ -906,12 +906,12 @@ </div> </div> <div id="footer"> - Generated on Sat Mar 15 14:04:13 2014 by + Generated on Sun Nov 2 09:40:01 2014 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.8.7.3 (ruby-2.1.0). + 0.8.7.6 (ruby-2.1.3). </div> </body> </html> \ No newline at end of file