alexrothenberg-metric_fu 1.0.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (47) hide show
  1. data/HISTORY +119 -0
  2. data/MIT-LICENSE +22 -0
  3. data/Manifest.txt +25 -0
  4. data/README +1 -0
  5. data/Rakefile +46 -0
  6. data/TODO +14 -0
  7. data/lib/base/base_template.rb +134 -0
  8. data/lib/base/configuration.rb +187 -0
  9. data/lib/base/generator.rb +156 -0
  10. data/lib/base/md5_tracker.rb +52 -0
  11. data/lib/base/report.rb +100 -0
  12. data/lib/generators/churn.rb +86 -0
  13. data/lib/generators/flay.rb +33 -0
  14. data/lib/generators/flog.rb +131 -0
  15. data/lib/generators/rcov.rb +80 -0
  16. data/lib/generators/reek.rb +36 -0
  17. data/lib/generators/roodi.rb +30 -0
  18. data/lib/generators/saikuro.rb +216 -0
  19. data/lib/generators/stats.rb +43 -0
  20. data/lib/metric_fu.rb +20 -0
  21. data/lib/templates/standard/churn.html.erb +30 -0
  22. data/lib/templates/standard/default.css +64 -0
  23. data/lib/templates/standard/flay.html.erb +33 -0
  24. data/lib/templates/standard/flog.html.erb +52 -0
  25. data/lib/templates/standard/index.html.erb +38 -0
  26. data/lib/templates/standard/rcov.html.erb +42 -0
  27. data/lib/templates/standard/reek.html.erb +41 -0
  28. data/lib/templates/standard/roodi.html.erb +28 -0
  29. data/lib/templates/standard/saikuro.html.erb +83 -0
  30. data/lib/templates/standard/standard_template.rb +26 -0
  31. data/lib/templates/standard/stats.html.erb +54 -0
  32. data/spec/base/base_template_spec.rb +140 -0
  33. data/spec/base/configuration_spec.rb +303 -0
  34. data/spec/base/generator_spec.rb +182 -0
  35. data/spec/base/md5_tracker_spec.rb +57 -0
  36. data/spec/base/report_spec.rb +139 -0
  37. data/spec/generators/churn_spec.rb +152 -0
  38. data/spec/generators/flay_spec.rb +101 -0
  39. data/spec/generators/flog_spec.rb +200 -0
  40. data/spec/generators/reek_spec.rb +59 -0
  41. data/spec/generators/saikuro_spec.rb +63 -0
  42. data/spec/generators/stats_spec.rb +74 -0
  43. data/spec/spec_helper.rb +28 -0
  44. data/tasks/metric_fu.rake +15 -0
  45. data/tasks/railroad.rake +39 -0
  46. data/vendor/saikuro/saikuro.rb +1214 -0
  47. metadata +113 -0
@@ -0,0 +1,64 @@
1
+ body {
2
+ background-color: #efefef;
3
+ margin: 20px;
4
+ padding: 0;
5
+ font: 12px verdana, arial, helvetica;
6
+ }
7
+
8
+ table {
9
+ border-collapse: collapse;
10
+ border: 1px solid #666;
11
+ background: #fff;
12
+ margin-bottom: 20px;
13
+ }
14
+
15
+ table tr.light {
16
+ background: #fff;
17
+ }
18
+
19
+ table tr.dark {
20
+ background: #f9f9f9;
21
+ }
22
+
23
+ table td, table th {
24
+ padding: 4px 10px;
25
+ font-size: 13px;
26
+ }
27
+ table th {
28
+ text-align: center;
29
+ color: #fc0;
30
+ background: #336;
31
+ font-weight: bold;
32
+ border: #d0d0d0 1px solid;
33
+ }
34
+
35
+ table td {
36
+ border: #d0d0d0 1px solid;
37
+ }
38
+
39
+ table td.score {
40
+ text-align: right;
41
+ }
42
+
43
+ .warning {
44
+ background: yellow;
45
+ }
46
+ .rcov_code td {
47
+ border-bottom: 1px solid #ddd ;
48
+ padding: 0;
49
+ margin: 0;
50
+ }
51
+ .rcov_code tr {
52
+ border: 0px;
53
+ padding:0px;
54
+ margin: 0px;
55
+ }
56
+ .rcov_code pre {
57
+ border: 0px;
58
+ padding: 0px;
59
+ margin: 0px;
60
+ }
61
+ .rcov_run {}
62
+ .rcov_not_run {
63
+ background-color: #d88;
64
+ }
@@ -0,0 +1,33 @@
1
+ <html>
2
+ <head>
3
+ <title>Flay Results</title>
4
+ <style>
5
+ <%= inline_css("default.css") %>
6
+ </style>
7
+ </head>
8
+
9
+ <body>
10
+ <h1>Flay Results</h1>
11
+ <h2>Total Score (lower is better): <%= @flay[:total_score] %></h2>
12
+ <p><a href='http://ruby.sadi.st/Flay.html'>Flay</a> analyzes ruby code for structural similarities.</p>
13
+ <table>
14
+ <tr>
15
+ <th>Files</th>
16
+ <th>Matches</th>
17
+ </tr>
18
+ <% count = 0 %>
19
+ <% @flay[:matches].each do |match| %>
20
+ <tr class='<%= cycle("light", "dark", count) %>'>
21
+ <td>
22
+ <% match[:matches].each do |file| %>
23
+ <%= file[:name] %>:<%= file[:line] %><br />
24
+ <% end %>
25
+ </td>
26
+ <td><%= match[:reason] %></td>
27
+ </tr>
28
+ <% count += 1 %>
29
+ <% end %>
30
+ </table>
31
+ <p>Generated on <%= Time.now.localtime %></p>
32
+ </body>
33
+ </html>
@@ -0,0 +1,52 @@
1
+ <html>
2
+ <head>
3
+ <title>Flog Reporter</title>
4
+ <style>
5
+ <%= inline_css("default.css") %>
6
+ </style>
7
+ </head>
8
+ <body>
9
+ <h1>Flog Results</h1>
10
+ <p><a href='http://ruby.sadi.st/Flog.html'>Flog</a> measures code complexity.</p>
11
+ <h2>Total Flog score for all methods: <%= @flog[:total]%></h2>
12
+ <h2>Average Flog score for all methods: <%= @flog[:average]%></h2>
13
+ <table>
14
+ <tr>
15
+ <th>File</th>
16
+ <th>Total score</th>
17
+ <th>Methods</th>
18
+ <th>Average score</th>
19
+ <th>Highest score</th>
20
+ </tr>
21
+ <% @flog[:pages].each do |page| %>
22
+ <tr>
23
+ <td><%= page[:path] %></td>
24
+ <td><%= page[:score].round %></td>
25
+ <td><%= page[:scanned_methods].length %></td>
26
+ <td><%= page[:average_score].round %></td>
27
+ <td><%= page[:highest_score].round %></td>
28
+ </tr>
29
+ <% end %>
30
+ </table>
31
+
32
+ <% @flog[:pages].each do |page| %>
33
+ <h2><%= page[:path] %></h2>
34
+ <% page[:scanned_methods].each do |sm| %>
35
+ <p><%= sm[:name] %></p>
36
+ <table>
37
+ <tr>
38
+ <th>Score</th>
39
+ <th>Operator</th>
40
+ </tr>
41
+ <% sm[:operators].each do |operator| %>
42
+ <tr>
43
+ <td><%= operator[:score] %></td>
44
+ <td><%= operator[:operator] %></td>
45
+ </tr>
46
+ <% end %>
47
+ </table>
48
+ <% end %>
49
+ <% end %>
50
+ <p>Generated on <%= Time.now.localtime %></p>
51
+ </body>
52
+ </html>
@@ -0,0 +1,38 @@
1
+ <html>
2
+ <head>
3
+ <title>Metric Fu Results</title>
4
+ <style>
5
+ <%= inline_css("default.css") %>
6
+ </style>
7
+ </head>
8
+
9
+ <body>
10
+ <h1>Metric Fu Results</h1>
11
+ <% if @churn %>
12
+ <p><a href="churn.html">Churn report</a></p>
13
+ <% end %>
14
+ <% if @flay %>
15
+ <p><a href="flay.html">Flay report</a></p>
16
+ <% end %>
17
+ <% if @flog %>
18
+ <p><a href="flog.html">Flog report</a></p>
19
+ <% end %>
20
+ <% if @rcov %>
21
+ <p><a href="rcov.html">Rcov report</a></p>
22
+ <% end %>
23
+ <% if @reek %>
24
+ <p><a href="reek.html">Reek report</a></p>
25
+ <% end %>
26
+ <% if @roodi %>
27
+ <p><a href="roodi.html">Roodi report</a></p>
28
+ <% end %>
29
+ <% if @saikuro %>
30
+ <p><a href="saikuro.html">Saikuro report</a></p>
31
+ <% end %>
32
+ <% if @stats %>
33
+ <p><a href="stats.html">Stats report</a></p>
34
+ <% end %>
35
+ <p>Generated on <%= Time.now.localtime %></p>
36
+ </body>
37
+ </html>
38
+
@@ -0,0 +1,42 @@
1
+ <html>
2
+ <head>
3
+ <title>Rcov Code Coverage Results</title>
4
+ <style>
5
+ <%= inline_css("default.css") %>
6
+ </style>
7
+ </head>
8
+
9
+ <body>
10
+ <h1>Rcov Code Coverage Results</h1>
11
+ <p>C0 code coverage information.</p>
12
+ <p>Total Coverage: <%= @rcov.delete(:global_percent_run) %>% </p>
13
+ <table>
14
+ <tr>
15
+ <th>File Path</th>
16
+ <th>Percent run</th>
17
+ </tr>
18
+ <% count = 0 %>
19
+ <% @rcov.each_pair do |fname, file| %>
20
+ <tr>
21
+ <td><%= fname %></td>
22
+ <td><%= file[:percent_run] %></td>
23
+ </tr>
24
+ <% count += 1 %>
25
+ <% end %>
26
+ </table>
27
+
28
+ <% @rcov.each_pair do |fname, file| %>
29
+ <h2> <%= fname %></h2>
30
+ <table class="rcov_code">
31
+ <% file[:lines].each do |line| %>
32
+ <tr>
33
+ <% css_class = line[:was_run] ? "rcov_run" : "rcov_not_run" %>
34
+ <td class="<%= css_class %>"><pre><%= line[:content] %></pre></td>
35
+ </tr>
36
+ <% end %>
37
+ </table>
38
+ <% end %>
39
+ <p>Generated on <%= Time.now.localtime %></p>
40
+ </body>
41
+ </html>
42
+
@@ -0,0 +1,41 @@
1
+ <html>
2
+ <head>
3
+ <title>Reek Results</title>
4
+ <style>
5
+ <%= inline_css("default.css") %>
6
+ </style>
7
+ </head>
8
+
9
+ <body>
10
+ <h1>Reek Results</h1>
11
+ <p><a href="http://reek.rubyforge.org/">Reek</a> detects common code smells in ruby code.</p>
12
+ <table>
13
+ <tr>
14
+ <th>File Path</th>
15
+ <th>Method</th>
16
+ <th>Description</th>
17
+ <th>Type</th>
18
+ </tr>
19
+ <% count = 0 %>
20
+ <% @reek[:matches].each do |match| %>
21
+ <% match[:code_smells].each do |smell| %>
22
+ <tr class='<%= cycle("light", "dark", count) %>'>
23
+ <td><%= match[:file_path] %></td>
24
+ <td>
25
+ <%= smell[:method] %>
26
+ </td>
27
+ <td>
28
+ <%= smell[:message] %>
29
+ </td>
30
+ <td>
31
+ <%= smell[:type] %>
32
+ </td>
33
+ </tr>
34
+ <% count += 1 %>
35
+ <% end %>
36
+ <% end %>
37
+
38
+ </table>
39
+ <p>Generated on <%= Time.now.localtime %></p>
40
+ </body>
41
+ </html>
@@ -0,0 +1,28 @@
1
+ <html>
2
+ <head>
3
+ <title>Roodi Results</title>
4
+ <style>
5
+ <%= inline_css("default.css") %>
6
+ </style>
7
+ </head>
8
+
9
+ <body>
10
+ <h1>Roodi Results</h1>
11
+ <p><a href="http://roodi.rubyforge.org/">Roodi</a> parses your Ruby code and warns you about design issues you have based on the checks that is has configured.</p>
12
+ <table>
13
+ <tr>
14
+ <th>File Path</th>
15
+ <th>Warning</th>
16
+ </tr>
17
+ <% count = 0 %>
18
+ <% @roodi[:problems].each do |problem| %>
19
+ <tr class='<%= cycle("light", "dark", count) %>'>
20
+ <td><%= problem[:file] %>:<%= problem[:line] %></td>
21
+ <td><%= problem[:problem] %></td>
22
+ </tr>
23
+ <% count += 1 %>
24
+ <% end %>
25
+ </table>
26
+ <p>Generated on <%= Time.now.localtime %></p>
27
+ </body>
28
+ </html>
@@ -0,0 +1,83 @@
1
+ <html>
2
+ <head>
3
+ <title>Saikuro Results</title>
4
+ <style>
5
+ <%= inline_css("default.css") %>
6
+ </style>
7
+ </head>
8
+
9
+ <body>
10
+ <h1>Saikuro Results</h1>
11
+ <p><a href='http://saikuro.rubyforge.org/'>Saikuro</a> analyzes ruby code for cyclomatic complexity.</p>
12
+
13
+ <h2>Analyzed Methods</h2>
14
+ <table>
15
+ <tr>
16
+ <th>Method Name</th>
17
+ <th>Complexity</th>
18
+ <th># Lines</th>
19
+ </tr>
20
+ <% @saikuro[:methods].each do |method| %>
21
+ <tr>
22
+ <td><%= method[:name] %></td>
23
+ <td><%= method[:complexity] %></td>
24
+ <td><%= method[:lines] %></td>
25
+ </tr>
26
+ <% end %>
27
+ </table>
28
+
29
+
30
+
31
+ <h2>Analyzed Classes</h2>
32
+ <table>
33
+ <tr>
34
+ <th>Class Name</th>
35
+ <th>Complexity</th>
36
+ <th># Lines</th>
37
+ </tr>
38
+ <% @saikuro[:classes].each do |klass| %>
39
+ <tr>
40
+ <td><%= klass[:name] %></td>
41
+ <td><%= klass[:complexity] %></td>
42
+ <td><%= klass[:lines] %></td>
43
+ </tr>
44
+ <% end %>
45
+ </table>
46
+
47
+
48
+ <h2>Analyzed Files</h2>
49
+ <% @saikuro[:files].each do |file| %>
50
+ <% file[:classes].each do |klass| %>
51
+ <% if !klass[:methods].empty? %>
52
+ <h3><%= file[:filename] %></h3>
53
+ <h4>Class : <%= klass[:class_name] %></h4>
54
+ <h5>Total complexity : <%= klass[:complexity] %></h5>
55
+ <h5>Total lines : <%= klass[:lines] %></h5>
56
+ <table>
57
+ <tr>
58
+ <th>Method</th>
59
+ <th>Complexity</th>
60
+ <th># Lines</th>
61
+ </tr>
62
+ <% klass[:methods].each do |method| %>
63
+ <tr>
64
+ <td>
65
+ <%= method[:name] %>
66
+ </td>
67
+ <td>
68
+ <%= method[:complexity] %>
69
+ </td>
70
+ <td>
71
+ <%= method[:lines] %>
72
+ </td>
73
+ </tr>
74
+ <% end %>
75
+ </table>
76
+ <% end %>
77
+ <% end %>
78
+ <% end %>
79
+
80
+ <p>Generated on <%= Time.now.localtime %></p>
81
+ </body>
82
+ </html>
83
+
@@ -0,0 +1,26 @@
1
+ class StandardTemplate < MetricFu::Template
2
+
3
+
4
+ def write
5
+ report.each_pair do |section, contents|
6
+ if template_exists?(section)
7
+ create_instance_var(section, contents)
8
+ html = erbify(section)
9
+ fn = output_filename(section)
10
+ MetricFu.report.save_output(html, MetricFu.output_directory, fn)
11
+ end
12
+ end
13
+
14
+ # Instance variables we need should already be created from above
15
+ if template_exists?('index')
16
+ html = erbify('index')
17
+ fn = output_filename('index')
18
+ MetricFu.report.save_output(html, MetricFu.output_directory, fn)
19
+ end
20
+ end
21
+
22
+ def this_directory
23
+ File.dirname(__FILE__)
24
+ end
25
+ end
26
+
@@ -0,0 +1,54 @@
1
+ <html>
2
+ <head>
3
+ <title>Rake Stats Results</title>
4
+ <style>
5
+ <%= inline_css("default.css") %>
6
+ </style>
7
+ </head>
8
+
9
+ <body>
10
+ <h1>Rake Stats Results</h1>
11
+ <p>Rails rake stats results.</p>
12
+ <table>
13
+ <tr>
14
+ <th>Lines of Code</th>
15
+ <th>Lines of Test</th>
16
+ <th>Code to test ratio</th>
17
+ </tr>
18
+ <tr>
19
+ <td><%= @stats[:codeLOC] %></td>
20
+ <td><%= @stats[:testLOC] %></td>
21
+ <td>1:<%= @stats[:code_to_test_ratio] %></td>
22
+ </tr>
23
+ </table>
24
+
25
+ <table>
26
+ <tr>
27
+ <th>Name</th>
28
+ <th>Lines</th>
29
+ <th>LOC</th>
30
+ <th>Classes</th>
31
+ <th>Methods</th>
32
+ <th>Methods per class</th>
33
+ <th>LOC per method</th>
34
+ </tr>
35
+ <% count = 0 %>
36
+ <% @stats[:lines].each do |line| %>
37
+ <tr>
38
+ <td><%= line[:name] %></td>
39
+ <td><%= line[:lines] %></td>
40
+ <td><%= line[:loc] %></td>
41
+ <td><%= line[:classes] %></td>
42
+ <td><%= line[:methods] %></td>
43
+ <td><%= line[:methods_per_class] %></td>
44
+ <td><%= line[:loc_per_method] %></td>
45
+ </tr>
46
+ <% count += 1 %>
47
+ <% end %>
48
+ </table>
49
+
50
+ <p>Generated on <%= Time.now.localtime %></p>
51
+ </body>
52
+ </html>
53
+
54
+