pjstadig-metric_fu 1.1.4.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (82) hide show
  1. data/HISTORY +155 -0
  2. data/MIT-LICENSE +22 -0
  3. data/Manifest.txt +25 -0
  4. data/README +1 -0
  5. data/Rakefile +18 -0
  6. data/TODO +9 -0
  7. data/lib/base/base_template.rb +146 -0
  8. data/lib/base/configuration.rb +187 -0
  9. data/lib/base/generator.rb +160 -0
  10. data/lib/base/graph.rb +38 -0
  11. data/lib/base/md5_tracker.rb +52 -0
  12. data/lib/base/report.rb +100 -0
  13. data/lib/generators/churn.rb +90 -0
  14. data/lib/generators/flay.rb +33 -0
  15. data/lib/generators/flog.rb +140 -0
  16. data/lib/generators/rcov.rb +91 -0
  17. data/lib/generators/reek.rb +37 -0
  18. data/lib/generators/roodi.rb +31 -0
  19. data/lib/generators/saikuro.rb +208 -0
  20. data/lib/generators/stats.rb +43 -0
  21. data/lib/graphs/flay_grapher.rb +35 -0
  22. data/lib/graphs/flog_grapher.rb +51 -0
  23. data/lib/graphs/grapher.rb +19 -0
  24. data/lib/graphs/rcov_grapher.rb +34 -0
  25. data/lib/graphs/reek_grapher.rb +44 -0
  26. data/lib/graphs/roodi_grapher.rb +34 -0
  27. data/lib/metric_fu.rb +30 -0
  28. data/lib/templates/awesome/awesome_template.rb +30 -0
  29. data/lib/templates/awesome/churn.html.erb +19 -0
  30. data/lib/templates/awesome/css/buttons.css +82 -0
  31. data/lib/templates/awesome/css/default.css +75 -0
  32. data/lib/templates/awesome/css/integrity.css +335 -0
  33. data/lib/templates/awesome/css/reset.css +7 -0
  34. data/lib/templates/awesome/flay.html.erb +27 -0
  35. data/lib/templates/awesome/flog.html.erb +47 -0
  36. data/lib/templates/awesome/index.html.erb +28 -0
  37. data/lib/templates/awesome/layout.html.erb +27 -0
  38. data/lib/templates/awesome/rcov.html.erb +36 -0
  39. data/lib/templates/awesome/reek.html.erb +34 -0
  40. data/lib/templates/awesome/roodi.html.erb +21 -0
  41. data/lib/templates/awesome/saikuro.html.erb +71 -0
  42. data/lib/templates/awesome/stats.html.erb +41 -0
  43. data/lib/templates/standard/churn.html.erb +31 -0
  44. data/lib/templates/standard/default.css +64 -0
  45. data/lib/templates/standard/flay.html.erb +34 -0
  46. data/lib/templates/standard/flog.html.erb +53 -0
  47. data/lib/templates/standard/index.html.erb +38 -0
  48. data/lib/templates/standard/rcov.html.erb +43 -0
  49. data/lib/templates/standard/reek.html.erb +42 -0
  50. data/lib/templates/standard/roodi.html.erb +29 -0
  51. data/lib/templates/standard/saikuro.html.erb +84 -0
  52. data/lib/templates/standard/standard_template.rb +26 -0
  53. data/lib/templates/standard/stats.html.erb +55 -0
  54. data/spec/base/base_template_spec.rb +161 -0
  55. data/spec/base/configuration_spec.rb +300 -0
  56. data/spec/base/generator_spec.rb +181 -0
  57. data/spec/base/graph_spec.rb +24 -0
  58. data/spec/base/md5_tracker_spec.rb +57 -0
  59. data/spec/base/report_spec.rb +139 -0
  60. data/spec/generators/churn_spec.rb +152 -0
  61. data/spec/generators/flay_spec.rb +104 -0
  62. data/spec/generators/flog_spec.rb +219 -0
  63. data/spec/generators/reek_spec.rb +60 -0
  64. data/spec/generators/saikuro_spec.rb +58 -0
  65. data/spec/generators/stats_spec.rb +74 -0
  66. data/spec/graphs/flay_grapher_spec.rb +44 -0
  67. data/spec/graphs/flog_grapher_spec.rb +61 -0
  68. data/spec/graphs/grapher_spec.rb +9 -0
  69. data/spec/graphs/rcov_grapher_spec.rb +44 -0
  70. data/spec/graphs/reek_grapher_spec.rb +53 -0
  71. data/spec/graphs/roodi_grapher_spec.rb +44 -0
  72. data/spec/resources/saikuro/app/controllers/sessions_controller.rb_cyclo.html +10 -0
  73. data/spec/resources/saikuro/app/controllers/users_controller.rb_cyclo.html +16 -0
  74. data/spec/resources/saikuro/index_cyclo.html +155 -0
  75. data/spec/resources/saikuro_sfiles/thing.rb_cyclo.html +11 -0
  76. data/spec/resources/yml/20090630.yml +7844 -0
  77. data/spec/spec.opts +8 -0
  78. data/spec/spec_helper.rb +6 -0
  79. data/tasks/metric_fu.rake +22 -0
  80. data/vendor/_fonts/monaco.ttf +0 -0
  81. data/vendor/saikuro/saikuro.rb +1219 -0
  82. metadata +180 -0
@@ -0,0 +1,24 @@
1
+ require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
2
+
3
+ describe MetricFu do
4
+
5
+ describe "responding to #graph" do
6
+ it "should return an instance of Graph" do
7
+ MetricFu.graph.should be_a(Graph)
8
+ end
9
+ end
10
+ end
11
+
12
+ describe MetricFu::Graph do
13
+
14
+ before(:each) do
15
+ @graph = MetricFu::Graph.new
16
+ end
17
+
18
+ describe "responding to #add" do
19
+ it 'should instantiate a grapher and push it to clazz' do
20
+ @graph.clazz.should_receive(:push).with(an_instance_of(RcovGrapher))
21
+ @graph.add("rcov")
22
+ end
23
+ end
24
+ end
@@ -0,0 +1,57 @@
1
+ require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
2
+
3
+ describe MetricFu::MD5Tracker do
4
+ before do
5
+ @tmp_dir = File.join(File.dirname(__FILE__), 'tmp')
6
+ FileUtils.mkdir_p(@tmp_dir, :verbose => false) unless File.directory?(@tmp_dir)
7
+ @file1 = File.new(File.join(@tmp_dir, 'file1.txt'), 'w')
8
+ @file2 = File.new(File.join(@tmp_dir, 'file2.txt'), 'w')
9
+ end
10
+
11
+ after do
12
+ FileUtils.rm_rf(@tmp_dir, :verbose => false)
13
+ end
14
+
15
+ it "identical files should match" do
16
+ @file1.puts("Hello World")
17
+ @file1.close
18
+ file1_md5 = MD5Tracker.track(@file1.path, @tmp_dir)
19
+
20
+ @file2.puts("Hello World")
21
+ @file2.close
22
+ file2_md5 = MD5Tracker.track(@file2.path, @tmp_dir)
23
+
24
+ file2_md5.should == file1_md5
25
+ end
26
+
27
+ it "different files should not match" do
28
+ @file1.puts("Hello World")
29
+ @file1.close
30
+ file1_md5 = MD5Tracker.track(@file1.path, @tmp_dir)
31
+
32
+ @file2.puts("Goodbye World")
33
+ @file2.close
34
+ file2_md5 = MD5Tracker.track(@file2.path, @tmp_dir)
35
+
36
+ file2_md5.should_not == file1_md5
37
+ end
38
+
39
+ it "file_changed? should detect a change" do
40
+ @file2.close
41
+
42
+ @file1.puts("Hello World")
43
+ @file1.close
44
+ file1_md5 = MD5Tracker.track(@file1.path, @tmp_dir)
45
+
46
+ @file1 = File.new(File.join(@tmp_dir, 'file1.txt'), 'w')
47
+ @file1.puts("Goodbye World")
48
+ @file1.close
49
+ MD5Tracker.file_changed?(@file1.path, @tmp_dir).should be_true
50
+ end
51
+
52
+ it "should detect a new file" do
53
+ @file2.close
54
+ MD5Tracker.file_changed?(@file1.path, @tmp_dir).should be_true
55
+ File.exist?(MD5Tracker.md5_file(@file1.path, @tmp_dir)).should be_true
56
+ end
57
+ end
@@ -0,0 +1,139 @@
1
+ require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
2
+
3
+ describe MetricFu do
4
+
5
+ describe "#report" do
6
+ it 'should return an instance of Report' do
7
+ MetricFu.report.instance_of?(Report).should be(true)
8
+ end
9
+ end
10
+ end
11
+
12
+ describe MetricFu::Report do
13
+
14
+ before(:each) do
15
+ @report = MetricFu::Report.new
16
+ end
17
+
18
+ describe "#to_yaml" do
19
+ it 'should call #report_hash' do
20
+ report_hash = mock('report_hash')
21
+ report_hash.should_receive(:to_yaml)
22
+ @report.should_receive(:report_hash).and_return(report_hash)
23
+ @report.to_yaml
24
+ end
25
+ end
26
+
27
+ describe "#report_hash" do
28
+ end
29
+
30
+ describe "#save_templatized_report" do
31
+ it 'should create a new template class assign a report_hash '\
32
+ 'to the template class, and ask it to write itself out' do
33
+ template_class = mock('template_class')
34
+ template_class.should_receive(:new).and_return(template_class)
35
+ MetricFu.should_receive(:template_class).and_return(template_class)
36
+ template_class.should_receive(:report=)
37
+ template_class.should_receive(:write)
38
+ @report.save_templatized_report
39
+ end
40
+ end
41
+
42
+ describe "#add" do
43
+ it 'should add a passed hash to the report_hash instance variable' do
44
+ report_type = mock('report_type')
45
+ report_type.should_receive(:to_s).and_return('type')
46
+ report_type.should_receive(:generate_report).and_return({:a => 'b'})
47
+ MetricFu.should_receive(:const_get).
48
+ with('Type').and_return(report_type)
49
+ report_hash = mock('report_hash')
50
+ report_hash.should_receive(:merge!).with({:a => 'b'})
51
+ @report.should_receive(:report_hash).and_return(report_hash)
52
+ @report.add(report_type)
53
+ end
54
+ end
55
+
56
+ describe "#save_output" do
57
+ it 'should write the passed content to dir/index.html' do
58
+ f = mock('file')
59
+ content = 'content'
60
+ @report.should_receive(:open).with('dir/file', 'w').and_yield(f)
61
+ f.should_receive(:puts).with(content)
62
+ @report.save_output(content, 'dir', 'file')
63
+ end
64
+ end
65
+
66
+ describe '#open_in_browser? ' do
67
+
68
+ before(:each) do
69
+ @config = mock('configuration')
70
+ end
71
+
72
+ describe 'when the platform is os x ' do
73
+
74
+ before(:each) do
75
+ @config.should_receive(:platform).and_return('darwin')
76
+ end
77
+
78
+ describe 'and we are in cruise control ' do
79
+
80
+ before(:each) do
81
+ @config.should_receive(:is_cruise_control_rb?).and_return(true)
82
+ MetricFu.stub!(:configuration).and_return(@config)
83
+ end
84
+
85
+ it 'should return false' do
86
+ @report.open_in_browser?.should be_false
87
+ end
88
+ end
89
+
90
+ describe 'and we are not in cruise control' do
91
+
92
+ before(:each) do
93
+ @config.should_receive(:is_cruise_control_rb?).and_return(false)
94
+ MetricFu.stub!(:configuration).and_return(@config)
95
+ end
96
+
97
+ it 'should return true' do
98
+ @report.open_in_browser?.should be_true
99
+ end
100
+ end
101
+ end
102
+
103
+ describe 'when the platform is not os x ' do
104
+ before(:each) do
105
+ @config.should_receive(:platform).and_return('other')
106
+ end
107
+
108
+ describe 'and we are in cruise control' do
109
+ before(:each) do
110
+ MetricFu.stub!(:configuration).and_return(@config)
111
+ end
112
+
113
+ it 'should return false' do
114
+ @report.open_in_browser?.should be_false
115
+ end
116
+ end
117
+
118
+ describe 'and we are not in cruise control' do
119
+ before(:each) do
120
+ MetricFu.stub!(:configuration).and_return(@config)
121
+ end
122
+
123
+ it 'should return false' do
124
+ @report.open_in_browser?.should be_false
125
+ end
126
+ end
127
+ end
128
+ end
129
+
130
+
131
+ describe '#show_in_browser' do
132
+ it 'should call open with the passed directory' do
133
+ @report.should_receive(:open_in_browser?).and_return(true)
134
+ @report.should_receive(:system).with("open my_dir/index.html")
135
+ @report.show_in_browser('my_dir')
136
+ end
137
+
138
+ end
139
+ end
@@ -0,0 +1,152 @@
1
+ require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
2
+
3
+ describe Churn do
4
+ describe "initialize" do
5
+ before :each do
6
+ MetricFu::Configuration.run {}
7
+ File.stub!(:directory?).and_return(true)
8
+ end
9
+
10
+ it "should setup git if .git exits" do
11
+ MetricFu::Churn.should_receive(:system).and_return(true)
12
+ Churn::Git.should_receive(:new)
13
+ MetricFu::Churn.new
14
+ end
15
+
16
+ it "should setup git if .svn exits" do
17
+ MetricFu::Churn.should_receive(:system).and_return(false)
18
+ File.should_receive(:exist?).with(".svn").and_return(true)
19
+ Churn::Svn.should_receive(:new)
20
+ MetricFu::Churn.new()
21
+ end
22
+
23
+ it "should raise an error if not .svn or .git" do
24
+ MetricFu::Churn.should_receive(:system).and_return(false)
25
+ lambda{MetricFu::Churn.new()}.should raise_error(Exception)
26
+ end
27
+ end
28
+
29
+ describe "emit method with git" do
30
+ before :each do
31
+ MetricFu::Configuration.run {|config| config.churn = {:minimum_churn_count => 2} }
32
+ File.stub!(:directory?).and_return(true)
33
+ MetricFu::Churn.should_receive(:system).and_return(true)
34
+ @git = Churn::Git.new
35
+ Churn::Git.should_receive(:new).and_return(@git)
36
+ @lines = <<-HERE.gsub(/^\s*/, "")
37
+
38
+ lib/generators/flog.rb
39
+ spec/generators/flog_spec.rb
40
+
41
+
42
+ lib/generators/flog.rb
43
+ spec/generators/flay_spec.rb
44
+
45
+
46
+ lib/metric_fu.rb
47
+
48
+
49
+ lib/generators/saikuro.rb
50
+ lib/metric_fu.rb
51
+ tasks/metric_fu.rake
52
+
53
+
54
+ spec/churn_spec.rb
55
+ spec/config_spec.rb
56
+ spec/flay_spec.rb
57
+ spec/flog_spec.rb
58
+ lib/metric_fu.rb
59
+ spec/reek_spec.rb
60
+ HERE
61
+ end
62
+
63
+ it "should read the logs" do
64
+ churn = MetricFu::Churn.new
65
+ @git.should_receive(:`).with("git log --name-only --pretty=format:").and_return(@lines)
66
+ changes = churn.emit
67
+ changes["lib/generators/flog.rb"].should == 2
68
+ changes["lib/metric_fu.rb"].should == 3
69
+ end
70
+ end
71
+
72
+ describe "emit method with svn" do
73
+ before :each do
74
+ MetricFu::Configuration.run{|config| config.churn = {:minimum_churn_count => 2} }
75
+ File.stub!(:directory?).and_return(true)
76
+ MetricFu::Churn.should_receive(:system).and_return(false)
77
+ File.should_receive(:exist?).with(".svn").and_return(true)
78
+ @svn = Churn::Svn.new
79
+ Churn::Svn.should_receive(:new).and_return(@svn)
80
+ @lines = <<-HERE.gsub(/^\s*/, "")
81
+ ------------------------------------------------------------------------
82
+ r3183 | dave | 2009-04-28 07:23:37 -0500 (Tue, 28 Apr 2009) | 1 line
83
+ Changed paths:
84
+ M /trunk/app/views/promotions/index.erb
85
+ M /trunk/app/models/email_personalizer.rb
86
+
87
+ making custom macros case-insensitive
88
+ ------------------------------------------------------------------------
89
+ r3182 | marc | 2009-04-28 03:59:32 -0500 (Tue, 28 Apr 2009) | 1 line
90
+ Changed paths:
91
+ M /trunk/app/models/file_extraction.rb
92
+ M /trunk/app/views/promotions/index.erb
93
+ M /trunk/config/environment.rb
94
+
95
+ Demo of the drop out effect for uploading promotions.
96
+ ------------------------------------------------------------------------
97
+ r3181 | dave | 2009-04-27 21:40:04 -0500 (Mon, 27 Apr 2009) | 1 line
98
+ Changed paths:
99
+ M /trunk/app/views/promotions/index.erb
100
+ A /trunk/app/models/file_extraction.rb
101
+ A /trunk/app/models/url_file_extraction.rb
102
+ M /trunk/app/models/zip_file_extraction.rb
103
+ M /trunk/test/data/zip_test.zip
104
+ M /trunk/test/unit/zip_file_extraction_test.rb
105
+
106
+ URL imports
107
+ HERE
108
+ end
109
+
110
+ it "should read the logs" do
111
+ churn = MetricFu::Churn.new
112
+ @svn.should_receive(:`).with("svn log --verbose").and_return(@lines)
113
+ changes = churn.emit
114
+ changes["/trunk/app/views/promotions/index.erb"].should == 3
115
+ changes["/trunk/app/models/file_extraction.rb"].should == 2
116
+ end
117
+ end
118
+
119
+ describe "analyze method" do
120
+ before :each do
121
+ MetricFu::Configuration.run {}
122
+ File.stub!(:directory?).and_return(true)
123
+ MetricFu::Churn.should_receive(:system).and_return(true)
124
+ @changes = {"lib/generators/flog.rb"=>2, "lib/metric_fu.rb"=>3}
125
+ end
126
+
127
+ it "should organize and format" do
128
+ churn = MetricFu::Churn.new
129
+ churn.instance_variable_set(:@changes, @changes)
130
+ changes = churn.analyze
131
+ changes.first[:file_path].should == "lib/metric_fu.rb"
132
+ changes.first[:times_changed].should == 3
133
+ changes[1][:file_path].should == "lib/generators/flog.rb"
134
+ changes[1][:times_changed].should == 2
135
+ end
136
+ end
137
+
138
+ describe "to_h method" do
139
+ before :each do
140
+ MetricFu::Configuration.run {}
141
+ File.stub!(:directory?).and_return(true)
142
+ MetricFu::Churn.should_receive(:system).and_return(true)
143
+ end
144
+
145
+ it "should put the changes into a hash" do
146
+ churn = MetricFu::Churn.new
147
+ churn.instance_variable_set(:@changes, "churn_info")
148
+ churn.to_h[:churn][:changes].should == "churn_info"
149
+ end
150
+ end
151
+ end
152
+
@@ -0,0 +1,104 @@
1
+ require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
2
+
3
+ describe Flay do
4
+ before :each do
5
+ MetricFu::Flay.stub!(:verify_dependencies!).and_return(true)
6
+ end
7
+ describe "emit method" do
8
+ before :each do
9
+ MetricFu::Configuration.run {|config| config.flay = { :dirs_to_flay => ['app', 'lib'] } }
10
+ File.stub!(:directory?).and_return(true)
11
+ @flay = MetricFu::Flay.new('base_dir')
12
+
13
+ end
14
+
15
+ it "should look at the dirs" do
16
+ Dir.should_receive(:[]).with(File.join("app", "**/*.rb")).and_return("path/to/app")
17
+ Dir.should_receive(:[]).with(File.join("lib", "**/*.rb")).and_return("path/to/lib")
18
+ @flay.should_receive(:`).with("flay path/to/app path/to/lib")
19
+ output = @flay.emit
20
+ end
21
+ end
22
+
23
+ describe "analyze method" do
24
+ before :each do
25
+ lines = <<-HERE
26
+ Total score (lower is better) = 246
27
+
28
+
29
+ 1) IDENTICAL code found in :or (mass*2 = 68)
30
+ app/controllers/link_targets_controller.rb:57
31
+ app/controllers/primary_sites_controller.rb:138
32
+
33
+ 2) Similar code found in :if (mass = 64)
34
+ app/controllers/primary_sites_controller.rb:75
35
+ app/controllers/primary_sites_controller.rb:76
36
+ app/controllers/primary_sites_controller.rb:88
37
+ app/controllers/primary_sites_controller.rb:89
38
+ HERE
39
+ MetricFu::Configuration.run {}
40
+ File.stub!(:directory?).and_return(true)
41
+ @flay = MetricFu::Flay.new('base_dir')
42
+ @flay.instance_variable_set(:@output, lines)
43
+ end
44
+
45
+ it "should analyze and return matches" do
46
+ @flay.analyze.should == [ ["Total score (lower is better) = 246"],
47
+ ["\n1) IDENTICAL code found in :or (mass*2 = 68)",
48
+ "app/controllers/link_targets_controller.rb:57",
49
+ "app/controllers/primary_sites_controller.rb:138"],
50
+ ["2) Similar code found in :if (mass = 64)",
51
+ "app/controllers/primary_sites_controller.rb:75",
52
+ "app/controllers/primary_sites_controller.rb:76",
53
+ "app/controllers/primary_sites_controller.rb:88",
54
+ "app/controllers/primary_sites_controller.rb:89"] ]
55
+ end
56
+ end
57
+
58
+ describe "to_h method" do
59
+
60
+ before :each do
61
+ lines = [ ["Total score (lower is better) = 284"],
62
+ ["\n1) IDENTICAL code found in :or (mass*2 = 68)",
63
+ "app/controllers/link_targets_controller.rb:57",
64
+ "app/controllers/primary_sites_controller.rb:138"],
65
+ ["2) Similar code found in :if (mass = 64)",
66
+ "app/controllers/primary_sites_controller.rb:75",
67
+ "app/controllers/primary_sites_controller.rb:76",
68
+ "app/controllers/primary_sites_controller.rb:88",
69
+ "app/controllers/primary_sites_controller.rb:89"],
70
+ ["3) Similar code found in :defn (mass = 40)",
71
+ "app/controllers/link_targets_controller.rb:40",
72
+ "app/controllers/primary_sites_controller.rb:98"],
73
+ ["4) Similar code found in :defn (mass = 38)",
74
+ "app/controllers/link_targets_controller.rb:13",
75
+ "app/controllers/primary_sites_controller.rb:50"],
76
+ ["5) Similar code found in :defn (mass = 38)",
77
+ "app/models/primary_site.rb:104",
78
+ "app/models/primary_site.rb:109"],
79
+ ["6) Similar code found in :call (mass = 36)",
80
+ "app/controllers/bookmarklet_integration_controller.rb:6",
81
+ "app/controllers/bookmarklet_integration_controller.rb:17"]]
82
+
83
+ MetricFu::Configuration.run {}
84
+ File.stub!(:directory?).and_return(true)
85
+ flay = MetricFu::Flay.new('base_dir')
86
+ flay.instance_variable_set(:@matches, lines)
87
+ @results = flay.to_h
88
+ end
89
+
90
+ it "should find the total_score" do
91
+ @results[:flay][:total_score].should == '284'
92
+ end
93
+
94
+ it "should have 6 matches" do
95
+ @results[:flay][:matches].size.should == 6
96
+ end
97
+
98
+ it "should capture info for match" do
99
+ @results[:flay][:matches].first[:reason].should =~ /IDENTICAL/
100
+ @results[:flay][:matches].first[:matches].first[:name].should =~ /link_targets_controller/
101
+ @results[:flay][:matches].first[:matches].first[:line].should == "57"
102
+ end
103
+ end
104
+ end