doc/Ballast/Concerns/Ajax.html in ballast-1.9.2 vs doc/Ballast/Concerns/Ajax.html in ballast-1.9.3
- old
+ new
@@ -137,25 +137,27 @@
<li class="public ">
<span class="summary_signature">
- <a href="#disallow_robots-instance_method" title="#disallow_robots (instance method)">- (Object) <strong>disallow_robots</strong> </a>
+ <a href="#generate_robots_txt-instance_method" title="#generate_robots_txt (instance method)">- (Object) <strong>generate_robots_txt</strong>(configuration = nil) </a>
+ (also: #disallow_robots)
+
</span>
- <span class="summary_desc"><div class='inline'><p>Disallows web robots.</p>
+ <span class="summary_desc"><div class='inline'><p>Generates a robots.txt file.</p>
</div></span>
</li>
@@ -416,43 +418,82 @@
</tr>
</table>
</div>
<div class="method_details ">
- <h3 class="signature " id="disallow_robots-instance_method">
+ <h3 class="signature " id="generate_robots_txt-instance_method">
- - (<tt>Object</tt>) <strong>disallow_robots</strong>
+ - (<tt>Object</tt>) <strong>generate_robots_txt</strong>(configuration = nil)
+ <span class="aliases">Also known as:
+ <span class="names"><span id='disallow_robots-instance_method'>disallow_robots</span></span>
+ </span>
+
</h3><div class="docstring">
<div class="discussion">
- <p>Disallows web robots.</p>
+ <p>Generates a robots.txt file.</p>
</div>
</div>
<div class="tags">
+ <p class="tag_title">Parameters:</p>
+<ul class="param">
+ <li>
+
+ <span class='name'>configuration</span>
+
+
+ <span class='type'>(<tt>Array</tt>)</span>
+
+
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
+
+
+ —
+ <div class='inline'><p>An array of list of agent and paths to include.</p>
+</div>
+
+ </li>
+
+</ul>
+
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
-94
-95
-96</pre>
+96
+97
+98
+99
+100
+101
+102
+103
+104
+105</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/ballast/concerns/ajax.rb', line 94</span>
+ <pre class="code"><span class="info file"># File 'lib/ballast/concerns/ajax.rb', line 96</span>
-<span class='kw'>def</span> <span class='id identifier rubyid_disallow_robots'>disallow_robots</span>
- <span class='id identifier rubyid_render'>render</span><span class='lparen'>(</span><span class='label'>text:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>User-agent: *\nDisallow: /</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>content_type:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>text/plain</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
+<span class='kw'>def</span> <span class='id identifier rubyid_generate_robots_txt'>generate_robots_txt</span><span class='lparen'>(</span><span class='id identifier rubyid_configuration'>configuration</span> <span class='op'>=</span> <span class='kw'>nil</span><span class='rparen'>)</span>
+ <span class='id identifier rubyid_rv'>rv</span> <span class='op'>=</span> <span class='id identifier rubyid_configuration'>configuration</span><span class='period'>.</span><span class='id identifier rubyid_ensure_array'>ensure_array</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>*</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='kw'>false</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_entry'>entry</span><span class='op'>|</span>
+ <span class='id identifier rubyid_agent'>agent</span> <span class='op'>=</span> <span class='id identifier rubyid_entry'>entry</span><span class='period'>.</span><span class='id identifier rubyid_shift'>shift</span>
+ <span class='id identifier rubyid_paths'>paths</span> <span class='op'>=</span> <span class='id identifier rubyid_entry'>entry</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_e'>e</span><span class='op'>|</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Disallow: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_e'>e</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='rbrace'>}</span>
+
+ <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>User-agent: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_agent'>agent</span><span class='embexpr_end'>}</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_paths'>paths</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
+ <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n\n</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
+
+ <span class='id identifier rubyid_render'>render</span><span class='lparen'>(</span><span class='label'>text:</span> <span class='id identifier rubyid_rv'>rv</span><span class='comma'>,</span> <span class='label'>content_type:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>text/plain</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
@@ -893,10 +934,10 @@
</div>
</div>
<div id="footer">
- Generated on Sun Mar 9 20:39:20 2014 by
+ Generated on Sat Mar 15 14:04:12 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).
</div>
</body>
\ No newline at end of file