doc/Guard/PHPSpec/Inspector.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>
Module: Guard::PHPSpec::Inspector
— Documentation by YARD 0.8.7
</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);
</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 (I)</a> »
<span class='title'><span class='object_link'><a href="../../Guard.html" title="Guard (module)">Guard</a></span></span> » <span class='title'><span class='object_link'><a href="../PHPSpec.html" title="Guard::PHPSpec (class)">PHPSpec</a></span></span>
»
<span class="title">Inspector</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: Guard::PHPSpec::Inspector
</h1>
<dl class="box">
<dt class="r1 last">Defined in:</dt>
<dd class="r1 last">lib/guard/phpspec/inspector.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>The Guard::PHPSpec inspector verifies that the changed paths are valid for
Guard::PHPSpec.</p>
</div>
</div>
<div class="tags">
</div>
<h2>Class Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#tests_path-class_method" title="tests_path (class method)">+ (Object) <strong>tests_path</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute tests_path.</p>
</div></span>
</li>
</ul>
<h2>
Class Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#clean-class_method" title="clean (class method)">+ (Array<String>) <strong>clean</strong>(paths) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Clean the changed paths and return only valid PHPSpec tests files.</p>
</div></span>
</li>
</ul>
<div id="class_attr_details" class="attr_details">
<h2>Class Attribute Details</h2>
<span id="tests_path=-class_method"></span>
<div class="method_details first">
<h3 class="signature first" id="tests_path-class_method">
+ (<tt>Object</tt>) <strong>tests_path</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute tests_path</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
10
11
12</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/guard/phpspec/inspector.rb', line 10</span>
<span class='kw'>def</span> <span class='id identifier rubyid_tests_path'>tests_path</span>
<span class='ivar'>@tests_path</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="clean-class_method">
+ (<tt>Array<String></tt>) <strong>clean</strong>(paths)
</h3><div class="docstring">
<div class="discussion">
<p>Clean the changed paths and return only valid PHPSpec tests files.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>paths</span>
<span class='type'>(<tt>Array<String></tt>)</span>
—
<div class='inline'>
<p>the changed paths</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array<String></tt>)</span>
—
<div class='inline'>
<p>the valid tests files</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
16
17
18
19
20
21
22</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/guard/phpspec/inspector.rb', line 16</span>
<span class='kw'>def</span> <span class='id identifier rubyid_clean'>clean</span><span class='lparen'>(</span><span class='id identifier rubyid_paths'>paths</span><span class='rparen'>)</span>
<span class='id identifier rubyid_paths'>paths</span><span class='period'>.</span><span class='id identifier rubyid_uniq!'>uniq!</span>
<span class='id identifier rubyid_paths'>paths</span><span class='period'>.</span><span class='id identifier rubyid_compact!'>compact!</span>
<span class='id identifier rubyid_paths'>paths</span> <span class='op'>=</span> <span class='id identifier rubyid_paths'>paths</span><span class='period'>.</span><span class='id identifier rubyid_select'>select</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_p'>p</span><span class='op'>|</span> <span class='id identifier rubyid_test_file?'>test_file?</span><span class='lparen'>(</span><span class='id identifier rubyid_p'>p</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
<span class='id identifier rubyid_clear_tests_files_list'>clear_tests_files_list</span>
<span class='id identifier rubyid_paths'>paths</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sat Aug 24 15:20:45 2013 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7 (ruby-2.0.0).
</div>
</body>
</html>