churn 1.0.1 → 1.0.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.travis.yml +2 -1
- data/Gemfile +1 -1
- data/Gemfile.lock +44 -38
- data/README.md +7 -7
- data/bin/churn +0 -1
- data/churn.gemspec +15 -14
- data/doc/Churn.html +165 -0
- data/doc/Churn/BzrAnalyzer.html +276 -0
- data/doc/Churn/ChurnCalculator.html +578 -0
- data/doc/Churn/ChurnHistory.html +250 -0
- data/doc/Churn/ChurnOptions.html +393 -0
- data/doc/Churn/GitAnalyzer.html +311 -0
- data/doc/Churn/HgAnalyzer.html +276 -0
- data/doc/Churn/LocationMapping.html +448 -0
- data/doc/Churn/SourceControl.html +451 -0
- data/doc/Churn/SvnAnalyzer.html +311 -0
- data/doc/LICENSE.html +123 -0
- data/doc/Object.html +246 -0
- data/doc/created.rid +15 -0
- data/doc/images/add.png +0 -0
- data/doc/images/arrow_up.png +0 -0
- data/doc/images/brick.png +0 -0
- data/doc/images/brick_link.png +0 -0
- data/doc/images/bug.png +0 -0
- data/doc/images/bullet_black.png +0 -0
- data/doc/images/bullet_toggle_minus.png +0 -0
- data/doc/images/bullet_toggle_plus.png +0 -0
- data/doc/images/date.png +0 -0
- data/doc/images/delete.png +0 -0
- data/doc/images/find.png +0 -0
- data/doc/images/loadingAnimation.gif +0 -0
- data/doc/images/macFFBgHack.png +0 -0
- data/doc/images/package.png +0 -0
- data/doc/images/page_green.png +0 -0
- data/doc/images/page_white_text.png +0 -0
- data/doc/images/page_white_width.png +0 -0
- data/doc/images/plugin.png +0 -0
- data/doc/images/ruby.png +0 -0
- data/doc/images/tag_blue.png +0 -0
- data/doc/images/tag_green.png +0 -0
- data/doc/images/transparent.png +0 -0
- data/doc/images/wrench.png +0 -0
- data/doc/images/wrench_orange.png +0 -0
- data/doc/images/zoom.png +0 -0
- data/doc/index.html +100 -0
- data/doc/js/darkfish.js +155 -0
- data/doc/js/jquery.js +18 -0
- data/doc/js/navigation.js +142 -0
- data/doc/js/search.js +94 -0
- data/doc/js/search_index.js +1 -0
- data/doc/js/searcher.js +228 -0
- data/doc/rdoc.css +595 -0
- data/doc/table_of_contents.html +167 -0
- data/lib/churn/calculator.rb +43 -43
- data/lib/churn/options.rb +3 -3
- data/lib/churn/scm/bzr_analyzer.rb +6 -2
- data/lib/churn/scm/git_analyzer.rb +19 -5
- data/lib/churn/scm/hg_analyzer.rb +5 -1
- data/lib/churn/scm/source_control.rb +15 -15
- data/lib/churn/scm/svn_analyzer.rb +5 -0
- data/lib/churn/version.rb +1 -1
- data/lib/tasks/churn_tasks.rb +1 -1
- data/test/data/churn_calculator.rb +14 -14
- data/test/data/test_helper.rb +5 -5
- data/test/test_helper.rb +5 -5
- data/test/unit/bzr_analyzer_test.rb +2 -2
- data/test/unit/churn_calculator_test.rb +1 -1
- data/test/unit/churn_history_test.rb +5 -5
- data/test/unit/churn_options_test.rb +3 -3
- data/test/unit/git_analyzer_test.rb +3 -3
- data/test/unit/hg_analyzer_test.rb +2 -2
- data/test/unit/location_mapping_test.rb +2 -2
- data/test/unit/source_control_test.rb +3 -3
- data/test/unit/svn_analyzer_test.rb +3 -3
- metadata +94 -76
@@ -0,0 +1,311 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
|
3
|
+
<html>
|
4
|
+
<head>
|
5
|
+
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
|
6
|
+
|
7
|
+
<title>class Churn::SvnAnalyzer - RDoc Documentation</title>
|
8
|
+
|
9
|
+
<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet">
|
10
|
+
|
11
|
+
<script type="text/javascript">
|
12
|
+
var rdoc_rel_prefix = "../";
|
13
|
+
</script>
|
14
|
+
|
15
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
16
|
+
<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script>
|
17
|
+
<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script>
|
18
|
+
<script type="text/javascript" charset="utf-8" src="../js/search.js"></script>
|
19
|
+
<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script>
|
20
|
+
<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script>
|
21
|
+
|
22
|
+
|
23
|
+
<body id="top" class="class">
|
24
|
+
<nav id="metadata">
|
25
|
+
<nav id="home-section" class="section">
|
26
|
+
<h3 class="section-header">
|
27
|
+
<a href="../index.html">Home</a>
|
28
|
+
<a href="../table_of_contents.html#classes">Classes</a>
|
29
|
+
<a href="../table_of_contents.html#methods">Methods</a>
|
30
|
+
</h3>
|
31
|
+
</nav>
|
32
|
+
|
33
|
+
|
34
|
+
<nav id="search-section" class="section project-section" class="initially-hidden">
|
35
|
+
<form action="#" method="get" accept-charset="utf-8">
|
36
|
+
<h3 class="section-header">
|
37
|
+
<input type="text" name="search" placeholder="Search" id="search-field"
|
38
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
39
|
+
</h3>
|
40
|
+
</form>
|
41
|
+
|
42
|
+
<ul id="search-results" class="initially-hidden"></ul>
|
43
|
+
</nav>
|
44
|
+
|
45
|
+
|
46
|
+
|
47
|
+
|
48
|
+
<div id="file-metadata">
|
49
|
+
<nav id="file-list-section" class="section">
|
50
|
+
<h3 class="section-header">Defined In</h3>
|
51
|
+
<ul>
|
52
|
+
<li>lib/churn/scm/svn_analyzer.rb
|
53
|
+
</ul>
|
54
|
+
</nav>
|
55
|
+
|
56
|
+
|
57
|
+
</div>
|
58
|
+
|
59
|
+
<div id="class-metadata">
|
60
|
+
|
61
|
+
<nav id="parent-class-section" class="section">
|
62
|
+
<h3 class="section-header">Parent</h3>
|
63
|
+
|
64
|
+
<p class="link"><a href="SourceControl.html">Churn::SourceControl</a>
|
65
|
+
|
66
|
+
</nav>
|
67
|
+
|
68
|
+
|
69
|
+
|
70
|
+
<!-- Method Quickref -->
|
71
|
+
<nav id="method-list-section" class="section">
|
72
|
+
<h3 class="section-header">Methods</h3>
|
73
|
+
|
74
|
+
<ul class="link-list">
|
75
|
+
|
76
|
+
<li ><a href="#method-c-supported-3F">::supported?</a>
|
77
|
+
|
78
|
+
<li ><a href="#method-i-get_logs">#get_logs</a>
|
79
|
+
|
80
|
+
<li ><a href="#method-i-get_revisions">#get_revisions</a>
|
81
|
+
|
82
|
+
<li ><a href="#method-i-get_updated_files_change_info">#get_updated_files_change_info</a>
|
83
|
+
|
84
|
+
</ul>
|
85
|
+
</nav>
|
86
|
+
|
87
|
+
</div>
|
88
|
+
|
89
|
+
<div id="project-metadata">
|
90
|
+
<nav id="fileindex-section" class="section project-section">
|
91
|
+
<h3 class="section-header">Pages</h3>
|
92
|
+
|
93
|
+
<ul>
|
94
|
+
|
95
|
+
<li class="file"><a href="../LICENSE.html">LICENSE</a>
|
96
|
+
|
97
|
+
</ul>
|
98
|
+
</nav>
|
99
|
+
|
100
|
+
<nav id="classindex-section" class="section project-section">
|
101
|
+
<h3 class="section-header">Class and Module Index</h3>
|
102
|
+
|
103
|
+
<ul class="link-list">
|
104
|
+
|
105
|
+
<li><a href="../Churn.html">Churn</a>
|
106
|
+
|
107
|
+
<li><a href="../Churn/BzrAnalyzer.html">Churn::BzrAnalyzer</a>
|
108
|
+
|
109
|
+
<li><a href="../Churn/ChurnCalculator.html">Churn::ChurnCalculator</a>
|
110
|
+
|
111
|
+
<li><a href="../Churn/ChurnHistory.html">Churn::ChurnHistory</a>
|
112
|
+
|
113
|
+
<li><a href="../Churn/ChurnOptions.html">Churn::ChurnOptions</a>
|
114
|
+
|
115
|
+
<li><a href="../Churn/GitAnalyzer.html">Churn::GitAnalyzer</a>
|
116
|
+
|
117
|
+
<li><a href="../Churn/HgAnalyzer.html">Churn::HgAnalyzer</a>
|
118
|
+
|
119
|
+
<li><a href="../Churn/LocationMapping.html">Churn::LocationMapping</a>
|
120
|
+
|
121
|
+
<li><a href="../Churn/SourceControl.html">Churn::SourceControl</a>
|
122
|
+
|
123
|
+
<li><a href="../Churn/SvnAnalyzer.html">Churn::SvnAnalyzer</a>
|
124
|
+
|
125
|
+
<li><a href="../Object.html">Object</a>
|
126
|
+
|
127
|
+
</ul>
|
128
|
+
</nav>
|
129
|
+
|
130
|
+
</div>
|
131
|
+
</nav>
|
132
|
+
|
133
|
+
<div id="documentation">
|
134
|
+
<h1 class="class">class Churn::SvnAnalyzer</h1>
|
135
|
+
|
136
|
+
<div id="description" class="description">
|
137
|
+
|
138
|
+
<p>analizes SVN SCM to find recently changed files, and what lines have been
|
139
|
+
altered</p>
|
140
|
+
|
141
|
+
</div><!-- description -->
|
142
|
+
|
143
|
+
|
144
|
+
|
145
|
+
|
146
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
147
|
+
|
148
|
+
|
149
|
+
|
150
|
+
|
151
|
+
|
152
|
+
|
153
|
+
|
154
|
+
|
155
|
+
<!-- Methods -->
|
156
|
+
|
157
|
+
<section id="public-class-5Buntitled-5D-method-details" class="method-section section">
|
158
|
+
<h3 class="section-header">Public Class Methods</h3>
|
159
|
+
|
160
|
+
|
161
|
+
<div id="method-c-supported-3F" class="method-detail ">
|
162
|
+
|
163
|
+
<div class="method-heading">
|
164
|
+
<span class="method-name">supported?</span><span
|
165
|
+
class="method-args">()</span>
|
166
|
+
|
167
|
+
<span class="method-click-advice">click to toggle source</span>
|
168
|
+
|
169
|
+
</div>
|
170
|
+
|
171
|
+
|
172
|
+
<div class="method-description">
|
173
|
+
|
174
|
+
|
175
|
+
|
176
|
+
|
177
|
+
|
178
|
+
|
179
|
+
<div class="method-source-code" id="supported-3F-source">
|
180
|
+
<pre><span class="ruby-comment"># File lib/churn/scm/svn_analyzer.rb, line 6</span>
|
181
|
+
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">supported?</span>
|
182
|
+
<span class="ruby-constant">File</span>.<span class="ruby-identifier">exist?</span>(<span class="ruby-string">".svn"</span>)
|
183
|
+
<span class="ruby-keyword">end</span></pre>
|
184
|
+
</div><!-- supported-3F-source -->
|
185
|
+
|
186
|
+
</div>
|
187
|
+
|
188
|
+
|
189
|
+
|
190
|
+
|
191
|
+
</div><!-- supported-3F-method -->
|
192
|
+
|
193
|
+
|
194
|
+
</section><!-- public-class-method-details -->
|
195
|
+
|
196
|
+
<section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
|
197
|
+
<h3 class="section-header">Public Instance Methods</h3>
|
198
|
+
|
199
|
+
|
200
|
+
<div id="method-i-get_logs" class="method-detail ">
|
201
|
+
|
202
|
+
<div class="method-heading">
|
203
|
+
<span class="method-name">get_logs</span><span
|
204
|
+
class="method-args">()</span>
|
205
|
+
|
206
|
+
<span class="method-click-advice">click to toggle source</span>
|
207
|
+
|
208
|
+
</div>
|
209
|
+
|
210
|
+
|
211
|
+
<div class="method-description">
|
212
|
+
|
213
|
+
|
214
|
+
|
215
|
+
|
216
|
+
|
217
|
+
|
218
|
+
<div class="method-source-code" id="get_logs-source">
|
219
|
+
<pre><span class="ruby-comment"># File lib/churn/scm/svn_analyzer.rb, line 10</span>
|
220
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_logs</span>
|
221
|
+
<span class="ruby-node">%xsvn log --verbose#{date_range}#{svn_credentials}`</span>.<span class="ruby-identifier">split</span>(<span class="ruby-regexp">/\n/</span>).<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">line</span><span class="ruby-operator">|</span> <span class="ruby-identifier">clean_up_svn_line</span>(<span class="ruby-identifier">line</span>) }.<span class="ruby-identifier">compact</span>
|
222
|
+
<span class="ruby-keyword">end</span></pre>
|
223
|
+
</div><!-- get_logs-source -->
|
224
|
+
|
225
|
+
</div>
|
226
|
+
|
227
|
+
|
228
|
+
|
229
|
+
|
230
|
+
</div><!-- get_logs-method -->
|
231
|
+
|
232
|
+
|
233
|
+
<div id="method-i-get_revisions" class="method-detail ">
|
234
|
+
|
235
|
+
<div class="method-heading">
|
236
|
+
<span class="method-name">get_revisions</span><span
|
237
|
+
class="method-args">()</span>
|
238
|
+
|
239
|
+
<span class="method-click-advice">click to toggle source</span>
|
240
|
+
|
241
|
+
</div>
|
242
|
+
|
243
|
+
|
244
|
+
<div class="method-description">
|
245
|
+
|
246
|
+
<p>below 2 methods aren’t supported by SVN so they become noops</p>
|
247
|
+
|
248
|
+
|
249
|
+
|
250
|
+
|
251
|
+
<div class="method-source-code" id="get_revisions-source">
|
252
|
+
<pre><span class="ruby-comment"># File lib/churn/scm/svn_analyzer.rb, line 15</span>
|
253
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_revisions</span>
|
254
|
+
[]
|
255
|
+
<span class="ruby-keyword">end</span></pre>
|
256
|
+
</div><!-- get_revisions-source -->
|
257
|
+
|
258
|
+
</div>
|
259
|
+
|
260
|
+
|
261
|
+
|
262
|
+
|
263
|
+
</div><!-- get_revisions-method -->
|
264
|
+
|
265
|
+
|
266
|
+
<div id="method-i-get_updated_files_change_info" class="method-detail ">
|
267
|
+
|
268
|
+
<div class="method-heading">
|
269
|
+
<span class="method-name">get_updated_files_change_info</span><span
|
270
|
+
class="method-args">(revision, revisions)</span>
|
271
|
+
|
272
|
+
<span class="method-click-advice">click to toggle source</span>
|
273
|
+
|
274
|
+
</div>
|
275
|
+
|
276
|
+
|
277
|
+
<div class="method-description">
|
278
|
+
|
279
|
+
|
280
|
+
|
281
|
+
|
282
|
+
|
283
|
+
|
284
|
+
<div class="method-source-code" id="get_updated_files_change_info-source">
|
285
|
+
<pre><span class="ruby-comment"># File lib/churn/scm/svn_analyzer.rb, line 19</span>
|
286
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">get_updated_files_change_info</span>(<span class="ruby-identifier">revision</span>, <span class="ruby-identifier">revisions</span>)
|
287
|
+
{}
|
288
|
+
<span class="ruby-keyword">end</span></pre>
|
289
|
+
</div><!-- get_updated_files_change_info-source -->
|
290
|
+
|
291
|
+
</div>
|
292
|
+
|
293
|
+
|
294
|
+
|
295
|
+
|
296
|
+
</div><!-- get_updated_files_change_info-method -->
|
297
|
+
|
298
|
+
|
299
|
+
</section><!-- public-instance-method-details -->
|
300
|
+
|
301
|
+
</section><!-- 5Buntitled-5D -->
|
302
|
+
|
303
|
+
</div><!-- documentation -->
|
304
|
+
|
305
|
+
|
306
|
+
<footer id="validator-badges">
|
307
|
+
<p><a href="http://validator.w3.org/check/referer">[Validate]</a>
|
308
|
+
<p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 4.0.1.
|
309
|
+
<p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
|
310
|
+
</footer>
|
311
|
+
|
data/doc/LICENSE.html
ADDED
@@ -0,0 +1,123 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
|
3
|
+
<html>
|
4
|
+
<head>
|
5
|
+
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
|
6
|
+
|
7
|
+
<title>LICENSE - RDoc Documentation</title>
|
8
|
+
|
9
|
+
<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">
|
10
|
+
|
11
|
+
<script type="text/javascript">
|
12
|
+
var rdoc_rel_prefix = "./";
|
13
|
+
</script>
|
14
|
+
|
15
|
+
<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
|
16
|
+
<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
|
17
|
+
<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
|
18
|
+
<script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
|
19
|
+
<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
|
20
|
+
<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>
|
21
|
+
|
22
|
+
|
23
|
+
<body class="file">
|
24
|
+
<nav id="metadata">
|
25
|
+
<nav id="home-section" class="section">
|
26
|
+
<h3 class="section-header">
|
27
|
+
<a href="./index.html">Home</a>
|
28
|
+
<a href="./table_of_contents.html#classes">Classes</a>
|
29
|
+
<a href="./table_of_contents.html#methods">Methods</a>
|
30
|
+
</h3>
|
31
|
+
</nav>
|
32
|
+
|
33
|
+
|
34
|
+
<nav id="search-section" class="section project-section" class="initially-hidden">
|
35
|
+
<form action="#" method="get" accept-charset="utf-8">
|
36
|
+
<h3 class="section-header">
|
37
|
+
<input type="text" name="search" placeholder="Search" id="search-field"
|
38
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
39
|
+
</h3>
|
40
|
+
</form>
|
41
|
+
|
42
|
+
<ul id="search-results" class="initially-hidden"></ul>
|
43
|
+
</nav>
|
44
|
+
|
45
|
+
|
46
|
+
|
47
|
+
|
48
|
+
<div id="project-metadata">
|
49
|
+
<nav id="fileindex-section" class="section project-section">
|
50
|
+
<h3 class="section-header">Pages</h3>
|
51
|
+
|
52
|
+
<ul>
|
53
|
+
|
54
|
+
<li class="file"><a href="./LICENSE.html">LICENSE</a>
|
55
|
+
|
56
|
+
</ul>
|
57
|
+
</nav>
|
58
|
+
|
59
|
+
<nav id="classindex-section" class="section project-section">
|
60
|
+
<h3 class="section-header">Class and Module Index</h3>
|
61
|
+
|
62
|
+
<ul class="link-list">
|
63
|
+
|
64
|
+
<li><a href="./Churn.html">Churn</a>
|
65
|
+
|
66
|
+
<li><a href="./Churn/BzrAnalyzer.html">Churn::BzrAnalyzer</a>
|
67
|
+
|
68
|
+
<li><a href="./Churn/ChurnCalculator.html">Churn::ChurnCalculator</a>
|
69
|
+
|
70
|
+
<li><a href="./Churn/ChurnHistory.html">Churn::ChurnHistory</a>
|
71
|
+
|
72
|
+
<li><a href="./Churn/ChurnOptions.html">Churn::ChurnOptions</a>
|
73
|
+
|
74
|
+
<li><a href="./Churn/GitAnalyzer.html">Churn::GitAnalyzer</a>
|
75
|
+
|
76
|
+
<li><a href="./Churn/HgAnalyzer.html">Churn::HgAnalyzer</a>
|
77
|
+
|
78
|
+
<li><a href="./Churn/LocationMapping.html">Churn::LocationMapping</a>
|
79
|
+
|
80
|
+
<li><a href="./Churn/SourceControl.html">Churn::SourceControl</a>
|
81
|
+
|
82
|
+
<li><a href="./Churn/SvnAnalyzer.html">Churn::SvnAnalyzer</a>
|
83
|
+
|
84
|
+
<li><a href="./Object.html">Object</a>
|
85
|
+
|
86
|
+
</ul>
|
87
|
+
</nav>
|
88
|
+
|
89
|
+
</div>
|
90
|
+
</nav>
|
91
|
+
|
92
|
+
<div id="documentation" class="description">
|
93
|
+
|
94
|
+
<p>Copyright © 2013 Dan Mayer</p>
|
95
|
+
|
96
|
+
<p>Permission is hereby granted, free of charge, to any person obtaining a
|
97
|
+
copy of this software and associated documentation files (the “Software”),
|
98
|
+
to deal in the Software without restriction, including without limitation
|
99
|
+
the rights to use, copy, modify, merge, publish, distribute, sublicense,
|
100
|
+
and/or sell copies of the Software, and to permit persons to whom the
|
101
|
+
Software is furnished to do so, subject to the following conditions:</p>
|
102
|
+
|
103
|
+
<p>The above copyright notice and this permission notice shall be included in
|
104
|
+
all copies or substantial portions of the Software.</p>
|
105
|
+
|
106
|
+
<p>THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
107
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
108
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
109
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
110
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
111
|
+
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
112
|
+
DEALINGS IN THE SOFTWARE.</p>
|
113
|
+
|
114
|
+
</div>
|
115
|
+
|
116
|
+
|
117
|
+
|
118
|
+
<footer id="validator-badges">
|
119
|
+
<p><a href="http://validator.w3.org/check/referer">[Validate]</a>
|
120
|
+
<p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 4.0.1.
|
121
|
+
<p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
|
122
|
+
</footer>
|
123
|
+
|
data/doc/Object.html
ADDED
@@ -0,0 +1,246 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
|
3
|
+
<html>
|
4
|
+
<head>
|
5
|
+
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
|
6
|
+
|
7
|
+
<title>class Object - RDoc Documentation</title>
|
8
|
+
|
9
|
+
<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">
|
10
|
+
|
11
|
+
<script type="text/javascript">
|
12
|
+
var rdoc_rel_prefix = "./";
|
13
|
+
</script>
|
14
|
+
|
15
|
+
<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
|
16
|
+
<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
|
17
|
+
<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
|
18
|
+
<script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
|
19
|
+
<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
|
20
|
+
<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>
|
21
|
+
|
22
|
+
|
23
|
+
<body id="top" class="class">
|
24
|
+
<nav id="metadata">
|
25
|
+
<nav id="home-section" class="section">
|
26
|
+
<h3 class="section-header">
|
27
|
+
<a href="./index.html">Home</a>
|
28
|
+
<a href="./table_of_contents.html#classes">Classes</a>
|
29
|
+
<a href="./table_of_contents.html#methods">Methods</a>
|
30
|
+
</h3>
|
31
|
+
</nav>
|
32
|
+
|
33
|
+
|
34
|
+
<nav id="search-section" class="section project-section" class="initially-hidden">
|
35
|
+
<form action="#" method="get" accept-charset="utf-8">
|
36
|
+
<h3 class="section-header">
|
37
|
+
<input type="text" name="search" placeholder="Search" id="search-field"
|
38
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
39
|
+
</h3>
|
40
|
+
</form>
|
41
|
+
|
42
|
+
<ul id="search-results" class="initially-hidden"></ul>
|
43
|
+
</nav>
|
44
|
+
|
45
|
+
|
46
|
+
|
47
|
+
|
48
|
+
<div id="file-metadata">
|
49
|
+
<nav id="file-list-section" class="section">
|
50
|
+
<h3 class="section-header">Defined In</h3>
|
51
|
+
<ul>
|
52
|
+
<li>bin/churn
|
53
|
+
<li>lib/tasks/churn_tasks.rb
|
54
|
+
</ul>
|
55
|
+
</nav>
|
56
|
+
|
57
|
+
|
58
|
+
</div>
|
59
|
+
|
60
|
+
<div id="class-metadata">
|
61
|
+
|
62
|
+
<nav id="parent-class-section" class="section">
|
63
|
+
<h3 class="section-header">Parent</h3>
|
64
|
+
|
65
|
+
<p class="link">BasicObject
|
66
|
+
|
67
|
+
</nav>
|
68
|
+
|
69
|
+
|
70
|
+
|
71
|
+
<!-- Method Quickref -->
|
72
|
+
<nav id="method-list-section" class="section">
|
73
|
+
<h3 class="section-header">Methods</h3>
|
74
|
+
|
75
|
+
<ul class="link-list">
|
76
|
+
|
77
|
+
<li ><a href="#method-i-report_churn">#report_churn</a>
|
78
|
+
|
79
|
+
<li ><a href="#method-i-run">#run</a>
|
80
|
+
|
81
|
+
</ul>
|
82
|
+
</nav>
|
83
|
+
|
84
|
+
</div>
|
85
|
+
|
86
|
+
<div id="project-metadata">
|
87
|
+
<nav id="fileindex-section" class="section project-section">
|
88
|
+
<h3 class="section-header">Pages</h3>
|
89
|
+
|
90
|
+
<ul>
|
91
|
+
|
92
|
+
<li class="file"><a href="./LICENSE.html">LICENSE</a>
|
93
|
+
|
94
|
+
</ul>
|
95
|
+
</nav>
|
96
|
+
|
97
|
+
<nav id="classindex-section" class="section project-section">
|
98
|
+
<h3 class="section-header">Class and Module Index</h3>
|
99
|
+
|
100
|
+
<ul class="link-list">
|
101
|
+
|
102
|
+
<li><a href="./Churn.html">Churn</a>
|
103
|
+
|
104
|
+
<li><a href="./Churn/BzrAnalyzer.html">Churn::BzrAnalyzer</a>
|
105
|
+
|
106
|
+
<li><a href="./Churn/ChurnCalculator.html">Churn::ChurnCalculator</a>
|
107
|
+
|
108
|
+
<li><a href="./Churn/ChurnHistory.html">Churn::ChurnHistory</a>
|
109
|
+
|
110
|
+
<li><a href="./Churn/ChurnOptions.html">Churn::ChurnOptions</a>
|
111
|
+
|
112
|
+
<li><a href="./Churn/GitAnalyzer.html">Churn::GitAnalyzer</a>
|
113
|
+
|
114
|
+
<li><a href="./Churn/HgAnalyzer.html">Churn::HgAnalyzer</a>
|
115
|
+
|
116
|
+
<li><a href="./Churn/LocationMapping.html">Churn::LocationMapping</a>
|
117
|
+
|
118
|
+
<li><a href="./Churn/SourceControl.html">Churn::SourceControl</a>
|
119
|
+
|
120
|
+
<li><a href="./Churn/SvnAnalyzer.html">Churn::SvnAnalyzer</a>
|
121
|
+
|
122
|
+
<li><a href="./Object.html">Object</a>
|
123
|
+
|
124
|
+
</ul>
|
125
|
+
</nav>
|
126
|
+
|
127
|
+
</div>
|
128
|
+
</nav>
|
129
|
+
|
130
|
+
<div id="documentation">
|
131
|
+
<h1 class="class">class Object</h1>
|
132
|
+
|
133
|
+
<div id="description" class="description">
|
134
|
+
|
135
|
+
</div><!-- description -->
|
136
|
+
|
137
|
+
|
138
|
+
|
139
|
+
|
140
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
141
|
+
|
142
|
+
|
143
|
+
|
144
|
+
|
145
|
+
|
146
|
+
|
147
|
+
|
148
|
+
|
149
|
+
<!-- Methods -->
|
150
|
+
|
151
|
+
<section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
|
152
|
+
<h3 class="section-header">Public Instance Methods</h3>
|
153
|
+
|
154
|
+
|
155
|
+
<div id="method-i-report_churn" class="method-detail ">
|
156
|
+
|
157
|
+
<div class="method-heading">
|
158
|
+
<span class="method-name">report_churn</span><span
|
159
|
+
class="method-args">(output_string)</span>
|
160
|
+
|
161
|
+
<span class="method-click-advice">click to toggle source</span>
|
162
|
+
|
163
|
+
</div>
|
164
|
+
|
165
|
+
|
166
|
+
<div class="method-description">
|
167
|
+
|
168
|
+
|
169
|
+
|
170
|
+
|
171
|
+
|
172
|
+
|
173
|
+
<div class="method-source-code" id="report_churn-source">
|
174
|
+
<pre><span class="ruby-comment"># File bin/churn, line 65</span>
|
175
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">report_churn</span>(<span class="ruby-identifier">output_string</span>)
|
176
|
+
<span class="ruby-identifier">options</span> = {<span class="ruby-value">:minimum_churn_count</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">params</span>[<span class="ruby-string">'minimum_churn_count'</span>].<span class="ruby-identifier">value</span>,
|
177
|
+
<span class="ruby-value">:ignore_files</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">params</span>[<span class="ruby-string">'ignore_files'</span>].<span class="ruby-identifier">value</span>,
|
178
|
+
<span class="ruby-value">:start_date</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">params</span>[<span class="ruby-string">'start_date'</span>].<span class="ruby-identifier">value</span>,
|
179
|
+
<span class="ruby-value">:data_directory</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">params</span>[<span class="ruby-string">'data_directory'</span>].<span class="ruby-identifier">value</span>,
|
180
|
+
<span class="ruby-value">:history</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">params</span>[<span class="ruby-string">'past_history'</span>].<span class="ruby-identifier">value</span>,
|
181
|
+
<span class="ruby-value">:report</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">params</span>[<span class="ruby-string">'report'</span>].<span class="ruby-identifier">value</span>,
|
182
|
+
<span class="ruby-value">:name</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">params</span>[<span class="ruby-string">'name'</span>].<span class="ruby-identifier">value</span>
|
183
|
+
}
|
184
|
+
<span class="ruby-identifier">result</span> = <span class="ruby-constant">Churn</span><span class="ruby-operator">::</span><span class="ruby-constant">ChurnCalculator</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">options</span>).<span class="ruby-identifier">report</span>(<span class="ruby-identifier">output_string</span>)
|
185
|
+
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">output_string</span>
|
186
|
+
<span class="ruby-identifier">result</span> = <span class="ruby-constant">YAML</span><span class="ruby-operator">::</span><span class="ruby-identifier">dump</span>(<span class="ruby-identifier">result</span>)
|
187
|
+
<span class="ruby-keyword">end</span>
|
188
|
+
<span class="ruby-identifier">result</span>
|
189
|
+
<span class="ruby-keyword">end</span></pre>
|
190
|
+
</div><!-- report_churn-source -->
|
191
|
+
|
192
|
+
</div>
|
193
|
+
|
194
|
+
|
195
|
+
|
196
|
+
|
197
|
+
</div><!-- report_churn-method -->
|
198
|
+
|
199
|
+
|
200
|
+
<div id="method-i-run" class="method-detail ">
|
201
|
+
|
202
|
+
<div class="method-heading">
|
203
|
+
<span class="method-name">run</span><span
|
204
|
+
class="method-args">()</span>
|
205
|
+
|
206
|
+
<span class="method-click-advice">click to toggle source</span>
|
207
|
+
|
208
|
+
</div>
|
209
|
+
|
210
|
+
|
211
|
+
<div class="method-description">
|
212
|
+
|
213
|
+
|
214
|
+
|
215
|
+
|
216
|
+
|
217
|
+
|
218
|
+
<div class="method-source-code" id="run-source">
|
219
|
+
<pre><span class="ruby-comment"># File bin/churn, line 81</span>
|
220
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">run</span>
|
221
|
+
<span class="ruby-identifier">report</span> = <span class="ruby-identifier">report_churn</span>(<span class="ruby-operator">!</span><span class="ruby-identifier">params</span>[<span class="ruby-string">'yaml'</span>].<span class="ruby-identifier">value</span>)
|
222
|
+
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">report</span>
|
223
|
+
<span class="ruby-keyword">end</span></pre>
|
224
|
+
</div><!-- run-source -->
|
225
|
+
|
226
|
+
</div>
|
227
|
+
|
228
|
+
|
229
|
+
|
230
|
+
|
231
|
+
</div><!-- run-method -->
|
232
|
+
|
233
|
+
|
234
|
+
</section><!-- public-instance-method-details -->
|
235
|
+
|
236
|
+
</section><!-- 5Buntitled-5D -->
|
237
|
+
|
238
|
+
</div><!-- documentation -->
|
239
|
+
|
240
|
+
|
241
|
+
<footer id="validator-badges">
|
242
|
+
<p><a href="http://validator.w3.org/check/referer">[Validate]</a>
|
243
|
+
<p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 4.0.1.
|
244
|
+
<p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
|
245
|
+
</footer>
|
246
|
+
|