Skip to content

Commit 1f36377

Browse files
committed
Rename tests/ to examples/, update README
1 parent 90891ae commit 1f36377

11 files changed

+15
-15
lines changed

README

+6-6
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Saikuro is a command line program.
3636
Running "saikuro -h" will output a usage statement describing all
3737
the various arguments you can pass to it.
3838

39-
"saikuro -c -p tests/samples.rb"
39+
"saikuro -c -p examples/samples.rb"
4040

4141
The above command is a simple example that generates a cyclomatic
4242
complexity report on the samples.rb file, using the default filter,
@@ -45,9 +45,9 @@ directory.
4545

4646

4747
A more detailed example is
48-
"saikuro -c -t -i tests -y 0 -w 11 -e 16 -o out/"
48+
"saikuro -c -t -i examples -y 0 -w 11 -e 16 -o detailed/"
4949

50-
This will analyze all Ruby files found in the "tests/" directory.
50+
This will analyze all Ruby files found in the "doc/examples/" directory.
5151
Saikuro will generate a token count report and a cyclomatic complexity
5252
report in the "out" directory . The "-y 0" command will turn off
5353
filtering and thus show the complexity of all methods. The "-w 11"
@@ -126,10 +126,10 @@ Mainly, because we have not gotten around to it. We are wondering if
126126
this would increase the noise more than it should.
127127

128128

129-
Tests:
130-
In the test directory is a sample file that has examples of the
129+
Examples:
130+
In the doc/examplesdirectory is a sample file that has examples of the
131131
various possible cases that we examined and documented the expected
132-
cyclomatic complexity result. If you find mistakes or missing tests
132+
cyclomatic complexity result. If you find mistakes or missing examples
133133
please report them.
134134

135135
Contact:

doc/detailed/tests/large_example.rb_token.html doc/detailed/examples/large_example.rb_token.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@
7575
</div>
7676
<div class="file_count">
7777
<p class="file_name">
78-
File: tests/large_example.rb
78+
File: examples/large_example.rb
7979
</p>
8080
<table width="100%" border="1">
8181
<tr><th>Line</th><th>Tokens</th></tr>

doc/detailed/tests/samples.rb_token.html doc/detailed/examples/samples.rb_token.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@
7575
</div>
7676
<div class="file_count">
7777
<p class="file_name">
78-
File: tests/samples.rb
78+
File: examples/samples.rb
7979
</p>
8080
<table width="100%" border="1">
8181
<tr><th>Line</th><th>Tokens</th></tr>

doc/detailed/index_cyclo.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -76,17 +76,17 @@ <h2 class="class_name">Errors and Warnings</h2>
7676
<table width="100%" border="1">
7777
<tr><th>Class</th><th>Method</th><th>Complexity</th></tr>
7878

79-
<tr><td><a href="./tests/large_example.rb_cyclo.html">ExtraTests</a></td><td>error_method_cc11</td>
79+
<tr><td><a href="./examples/large_example.rb_cyclo.html">ExtraTests</a></td><td>error_method_cc11</td>
8080
<td class="warning">11</td></tr>
8181
</table>
8282
<hr/>
8383
<h2 class="class_name">Analyzed Files</h2>
8484
<ul>
8585
<li>
86-
<p class="file_name"><a href="./tests/large_example.rb_cyclo.html">tests/large_example.rb</a>
86+
<p class="file_name"><a href="./examples/large_example.rb_cyclo.html">examples/large_example.rb</a>
8787
</li>
8888
<li>
89-
<p class="file_name"><a href="./tests/samples.rb_cyclo.html">tests/samples.rb</a>
89+
<p class="file_name"><a href="./examples/samples.rb_cyclo.html">examples/samples.rb</a>
9090
</li>
9191
</ul>
9292
</body></html>

doc/detailed/index_token.html

+3-3
Original file line numberDiff line numberDiff line change
@@ -75,18 +75,18 @@ <h1>Index for tokens per line</h1>
7575
<h2 class="class_name">Errors and Warnings</h2>
7676
<table width="100%" border="1">
7777
<tr><th>File</th><th>Line #</th><th>Tokens</th></tr>
78-
<tr><td><a href="./tests/large_example.rb_token.html">tests/large_example.rb</a></td><td>31</td>
78+
<tr><td><a href="./examples/large_example.rb_token.html">examples/large_example.rb</a></td><td>31</td>
7979
<td class="error">47</td></tr>
8080

8181
</table>
8282
<hr/>
8383
<h2 class="class_name">Analyzed Files</h2>
8484
<ul>
8585
<li>
86-
<p class="file_name"><a href="./tests/large_example.rb_token.html">tests/large_example.rb</a>
86+
<p class="file_name"><a href="./examples/large_example.rb_token.html">examples/large_example.rb</a>
8787
</li>
8888
<li>
89-
<p class="file_name"><a href="./tests/samples.rb_token.html">tests/samples.rb</a>
89+
<p class="file_name"><a href="./examples/samples.rb_token.html">examples/samples.rb</a>
9090
</li>
9191
</ul>
9292
</body></html>
File renamed without changes.
File renamed without changes.
File renamed without changes.

doc/index_cyclo.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ <h1>Index for cyclomatic complexity</h1>
7777
<h2 class="class_name">Analyzed Files</h2>
7878
<ul>
7979
<li>
80-
<p class="file_name"><a href="./tests/samples.rb_cyclo.html">tests/samples.rb</a>
80+
<p class="file_name"><a href="./examples/samples.rb_cyclo.html">examples/samples.rb</a>
8181
</li>
8282
</ul>
8383
</body></html>

0 commit comments

Comments
 (0)