<!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>
Module: Brauser::BrowserMethods::Attributes
— Documentation by YARD 0.8.4.1
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" 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);
</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 (A)</a> »
<span class='title'><span class='object_link'><a href="../../Brauser.html" title="Brauser (module)">Brauser</a></span></span> » <span class='title'><span class='object_link'><a href="../BrowserMethods.html" title="Brauser::BrowserMethods (module)">BrowserMethods</a></span></span>
»
<span class="title">Attributes</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>Module: Brauser::BrowserMethods::Attributes
</h1>
<dl class="box">
<dt class="r1">Included in:</dt>
<dd class="r1"><span class='object_link'><a href="../Browser.html" title="Brauser::Browser (class)">Brauser::Browser</a></span></dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/brauser/browser.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Methods to handle attributes</p>
</div>
</div>
<div class="tags">
</div>
<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="#classes-instance_method" title="#classes (instance method)">- (String|Array) <strong>classes</strong>(join = " ", name = "", version = "version-", platform = "platform-", &block) </a>
(also: #meta)
</span>
<span class="summary_desc"><div class='inline'><p>Returns an array of information about the browser.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#platform_name-instance_method" title="#platform_name (instance method)">- (String) <strong>platform_name</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Gets a human-readable platform name.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#readable_name-instance_method" title="#readable_name (instance method)">- (String) <strong>readable_name</strong> </a>
</span>
<span class="summary_desc"><div class='inline'><p>Gets a human-readable browser name.</p>
</div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="classes-instance_method">
- (<tt>String|Array</tt>) <strong>classes</strong>(join = " ", name = "", version = "version-", platform = "platform-", &block)
<span class="aliases">Also known as:
<span class="names"><span id='meta-instance_method'>meta</span></span>
</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns an array of information about the browser. Information are strings which are suitable to use as CSS classes.</p>
<p>For version, it will be included a class for every token of the version. For example, version <code>7.0.1.2</code> will return this:</p>
<p><code>ruby
["version-7", "version-7_0", "version-7_0_1", "version-7_0_1_2"]
</code></p>
<p>If you provide a block (with accepts name, version and platform as arguments), it will be used for translating the name.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>join</span>
<span class='type'>(<tt>String|NilClass</tt>)</span>
<em class="default">(defaults to: <tt>" "</tt>)</em>
—
<div class='inline'><p>If non falsy, the separator to use to join information. If falsy, informations will be returned as array.</p>
</div>
</li>
<li>
<span class='name'>name</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>""</tt>)</em>
—
<div class='inline'><p>If non falsy, the string to prepend to the name. If falsy, the name information will not be included.</p>
</div>
</li>
<li>
<span class='name'>version</span>
<span class='type'>(<tt>String|NilClass</tt>)</span>
<em class="default">(defaults to: <tt>"version-"</tt>)</em>
—
<div class='inline'><p>If non falsy, the string to prepend to the version. If falsy, the version information will not be included.</p>
</div>
</li>
<li>
<span class='name'>platform</span>
<span class='type'>(<tt>String|NilClass</tt>)</span>
<em class="default">(defaults to: <tt>"platform-"</tt>)</em>
—
<div class='inline'><p>If non falsy, the string to prepend to the platform. If falsy, the platform information will not be included.</p>
</div>
</li>
<li>
<span class='name'>block</span>
<span class='type'>(<tt>Proc</tt>)</span>
—
<div class='inline'><p>A block to translate browser name.</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String|Array</tt>)</span>
—
<div class='inline'><p>CSS ready information of the current browser.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
443
444
445
446
447</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/brauser/browser.rb', line 443</span>
<span class='kw'>def</span> <span class='id identifier rubyid_classes'>classes</span><span class='lparen'>(</span><span class='id identifier rubyid_join'>join</span> <span class='op'>=</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='id identifier rubyid_name'>name</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='id identifier rubyid_version'>version</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>version-</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid_platform'>platform</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>platform-</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
<span class='id identifier rubyid_platform'>platform</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>platform-</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_platform'>platform</span> <span class='op'>==</span> <span class='kw'>true</span>
<span class='id identifier rubyid_rv'>rv</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='id identifier rubyid_stringify_name'>stringify_name</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_stringify_version'>stringify_version</span><span class='lparen'>(</span><span class='id identifier rubyid_version'>version</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='op'>!</span><span class='id identifier rubyid_platform'>platform</span> <span class='op'>?</span> <span class='kw'>nil</span> <span class='op'>:</span> <span class='lparen'>(</span><span class='id identifier rubyid_platform'>platform</span> <span class='op'>+</span> <span class='ivar'>@platform</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_compact'>compact</span><span class='period'>.</span><span class='id identifier rubyid_flatten'>flatten</span>
<span class='id identifier rubyid_join'>join</span> <span class='op'>?</span> <span class='id identifier rubyid_rv'>rv</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='id identifier rubyid_join'>join</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='id identifier rubyid_rv'>rv</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="platform_name-instance_method">
- (<tt>String</tt>) <strong>platform_name</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Gets a human-readable platform name.</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 readable platform name.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
422
423
424
425</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/brauser/browser.rb', line 422</span>
<span class='kw'>def</span> <span class='id identifier rubyid_platform_name'>platform_name</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_parse_agent'>parse_agent</span><span class='lparen'>(</span><span class='ivar'>@agent</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='op'>!</span><span class='ivar'>@platform</span>
<span class='op'>::</span><span class='const'>Brauser</span><span class='op'>::</span><span class='const'>Browser</span><span class='period'>.</span><span class='id identifier rubyid_platforms'>platforms</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='ivar'>@platform</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Unknown Platform</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_last'>last</span><span class='period'>.</span><span class='id identifier rubyid_ensure_string'>ensure_string</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="readable_name-instance_method">
- (<tt>String</tt>) <strong>readable_name</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Gets a human-readable browser name.</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 human-readable browser name.</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
414
415
416
417</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/brauser/browser.rb', line 414</span>
<span class='kw'>def</span> <span class='id identifier rubyid_readable_name'>readable_name</span>
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_parse_agent'>parse_agent</span><span class='lparen'>(</span><span class='ivar'>@agent</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='op'>!</span><span class='ivar'>@name</span>
<span class='op'>::</span><span class='const'>Brauser</span><span class='op'>::</span><span class='const'>Browser</span><span class='period'>.</span><span class='id identifier rubyid_browsers'>browsers</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='ivar'>@name</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Unknown Browser</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_last'>last</span><span class='period'>.</span><span class='id identifier rubyid_ensure_string'>ensure_string</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Fri Feb 8 08:12:32 2013 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.4.1 (ruby-1.9.3).
</div>
</body>
</html>