garfield/wpscan
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
3a3cbfdf7d6788372d086dcc7a803d017f1f94f8
wpscan/doc_yard/SvnParser.html
Christian Mehlmauer bf10b25291 docs
2013-07-19 23:10:56 +02:00

572 lines
12 KiB
HTML
Raw Blame History

<!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: SvnParser
&mdash; Documentation by YARD 0.8.5.2
</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 (S)</a> &raquo;
<span class="title">SvnParser</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: SvnParser
</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">SvnParser</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/wpstools/plugins/list_generator/svn_parser.rb</dd>
</dl>
<div class="clear"></div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>This Class Parses SVN Repositories via HTTP</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="#keep_empty_dirs-instance_method" title="#keep_empty_dirs (instance method)">- (Object) <strong>keep_empty_dirs</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute keep_empty_dirs.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#svn_root-instance_method" title="#svn_root (instance method)">- (Object) <strong>svn_root</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute svn_root.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#verbose-instance_method" title="#verbose (instance method)">- (Object) <strong>verbose</strong> </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute verbose.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="private ">
<span class="summary_signature">
<a href="#get_root_directories-instance_method" title="#get_root_directories (instance method)">- (Object) <strong>get_root_directories</strong> </a>
</span>
<span class="note title private">private</span>
<span class="summary_desc"><div class='inline'>
<p>Gets all directories in the SVN root.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">- (SvnParser) <strong>initialize</strong>(svn_root) </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of SvnParser.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#parse-instance_method" title="#parse (instance method)">- (Object) <strong>parse</strong> </a>
</span>
<span class="summary_desc"><div class='inline'></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="SvnParser (class)">SvnParser</a></span></tt>) <strong>initialize</strong>(svn_root)
</h3><div class="docstring">
<div class="discussion">
<p>A new instance of SvnParser</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
8
9
10</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/wpstools/plugins/list_generator/svn_parser.rb', line 8</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_svn_root'>svn_root</span><span class='rparen'>)</span>
<span class='ivar'>@svn_root</span> <span class='op'>=</span> <span class='id identifier rubyid_svn_root'>svn_root</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="keep_empty_dirs=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="keep_empty_dirs-instance_method">
- (<tt>Object</tt>) <strong>keep_empty_dirs</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute keep_empty_dirs</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
6
7
8</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/wpstools/plugins/list_generator/svn_parser.rb', line 6</span>
<span class='kw'>def</span> <span class='id identifier rubyid_keep_empty_dirs'>keep_empty_dirs</span>
<span class='ivar'>@keep_empty_dirs</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="svn_root=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="svn_root-instance_method">
- (<tt>Object</tt>) <strong>svn_root</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute svn_root</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
6
7
8</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/wpstools/plugins/list_generator/svn_parser.rb', line 6</span>
<span class='kw'>def</span> <span class='id identifier rubyid_svn_root'>svn_root</span>
<span class='ivar'>@svn_root</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="verbose=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="verbose-instance_method">
- (<tt>Object</tt>) <strong>verbose</strong>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute verbose</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
6
7
8</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/wpstools/plugins/list_generator/svn_parser.rb', line 6</span>
<span class='kw'>def</span> <span class='id identifier rubyid_verbose'>verbose</span>
<span class='ivar'>@verbose</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="get_root_directories-instance_method">
- (<tt>Object</tt>) <strong>get_root_directories</strong> <span class="extras">(private)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Gets all directories in the SVN root</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
20
21
22
23
24
25
26
27
28
29
30</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/wpstools/plugins/list_generator/svn_parser.rb', line 20</span>
<span class='kw'>def</span> <span class='id identifier rubyid_get_root_directories'>get_root_directories</span>
<span class='id identifier rubyid_dirs'>dirs</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_rootindex'>rootindex</span> <span class='op'>=</span> <span class='const'>Browser</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='ivar'>@svn_root</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_body'>body</span>
<span class='id identifier rubyid_rootindex'>rootindex</span><span class='period'>.</span><span class='id identifier rubyid_scan'>scan</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>%r{</span><span class='tstring_content'>&lt;li&gt;&lt;a href=&quot;.+&quot;&gt;(.+)/&lt;/a&gt;&lt;/li&gt;</span><span class='regexp_end'>}i</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_dir'>dir</span><span class='op'>|</span>
<span class='id identifier rubyid_dirs'>dirs</span> <span class='op'>&lt;&lt;</span> <span class='id identifier rubyid_dir'>dir</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_dirs'>dirs</span><span class='period'>.</span><span class='id identifier rubyid_sort!'>sort!</span>
<span class='id identifier rubyid_dirs'>dirs</span><span class='period'>.</span><span class='id identifier rubyid_uniq'>uniq</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="parse-instance_method">
- (<tt>Object</tt>) <strong>parse</strong>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
12
13
14</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/wpstools/plugins/list_generator/svn_parser.rb', line 12</span>
<span class='kw'>def</span> <span class='id identifier rubyid_parse'>parse</span>
<span class='id identifier rubyid_get_root_directories'>get_root_directories</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Fri Jul 19 23:10:17 2013 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.5.2 (ruby-1.9.3).
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink