flyerhzm-metric_fu 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (92) hide show
  1. data/HISTORY +164 -0
  2. data/MIT-LICENSE +22 -0
  3. data/Manifest.txt +25 -0
  4. data/README.textile +27 -0
  5. data/Rakefile +18 -0
  6. data/TODO +9 -0
  7. data/lib/base/base_template.rb +145 -0
  8. data/lib/base/configuration.rb +180 -0
  9. data/lib/base/generator.rb +167 -0
  10. data/lib/base/graph.rb +39 -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 +34 -0
  15. data/lib/generators/flog.rb +167 -0
  16. data/lib/generators/rails_best_practices.rb +31 -0
  17. data/lib/generators/rcov.rb +87 -0
  18. data/lib/generators/reek.rb +64 -0
  19. data/lib/generators/roodi.rb +32 -0
  20. data/lib/generators/saikuro.rb +208 -0
  21. data/lib/generators/stats.rb +43 -0
  22. data/lib/graphs/engines/bluff.rb +98 -0
  23. data/lib/graphs/engines/gchart.rb +119 -0
  24. data/lib/graphs/flay_grapher.rb +20 -0
  25. data/lib/graphs/flog_grapher.rb +40 -0
  26. data/lib/graphs/grapher.rb +11 -0
  27. data/lib/graphs/rails_best_practices_grapher.rb +20 -0
  28. data/lib/graphs/rcov_grapher.rb +20 -0
  29. data/lib/graphs/reek_grapher.rb +32 -0
  30. data/lib/graphs/roodi_grapher.rb +20 -0
  31. data/lib/metric_fu.rb +31 -0
  32. data/lib/templates/awesome/awesome_template.rb +37 -0
  33. data/lib/templates/awesome/churn.html.erb +19 -0
  34. data/lib/templates/awesome/css/buttons.css +82 -0
  35. data/lib/templates/awesome/css/default.css +75 -0
  36. data/lib/templates/awesome/css/integrity.css +335 -0
  37. data/lib/templates/awesome/css/reset.css +7 -0
  38. data/lib/templates/awesome/flay.html.erb +33 -0
  39. data/lib/templates/awesome/flog.html.erb +53 -0
  40. data/lib/templates/awesome/index.html.erb +31 -0
  41. data/lib/templates/awesome/layout.html.erb +30 -0
  42. data/lib/templates/awesome/rails_best_practices.html.erb +27 -0
  43. data/lib/templates/awesome/rcov.html.erb +42 -0
  44. data/lib/templates/awesome/reek.html.erb +40 -0
  45. data/lib/templates/awesome/roodi.html.erb +27 -0
  46. data/lib/templates/awesome/saikuro.html.erb +71 -0
  47. data/lib/templates/awesome/stats.html.erb +41 -0
  48. data/lib/templates/javascripts/bluff-min.js +1 -0
  49. data/lib/templates/javascripts/excanvas.js +19 -0
  50. data/lib/templates/javascripts/js-class.js +1 -0
  51. data/lib/templates/standard/churn.html.erb +31 -0
  52. data/lib/templates/standard/default.css +64 -0
  53. data/lib/templates/standard/flay.html.erb +34 -0
  54. data/lib/templates/standard/flog.html.erb +53 -0
  55. data/lib/templates/standard/index.html.erb +41 -0
  56. data/lib/templates/standard/rails_best_practices.html.erb +29 -0
  57. data/lib/templates/standard/rcov.html.erb +43 -0
  58. data/lib/templates/standard/reek.html.erb +42 -0
  59. data/lib/templates/standard/roodi.html.erb +29 -0
  60. data/lib/templates/standard/saikuro.html.erb +84 -0
  61. data/lib/templates/standard/standard_template.rb +26 -0
  62. data/lib/templates/standard/stats.html.erb +55 -0
  63. data/spec/base/base_template_spec.rb +161 -0
  64. data/spec/base/configuration_spec.rb +269 -0
  65. data/spec/base/generator_spec.rb +244 -0
  66. data/spec/base/graph_spec.rb +24 -0
  67. data/spec/base/md5_tracker_spec.rb +57 -0
  68. data/spec/base/report_spec.rb +139 -0
  69. data/spec/generators/churn_spec.rb +152 -0
  70. data/spec/generators/flay_spec.rb +104 -0
  71. data/spec/generators/flog_spec.rb +238 -0
  72. data/spec/generators/reek_spec.rb +126 -0
  73. data/spec/generators/saikuro_spec.rb +58 -0
  74. data/spec/generators/stats_spec.rb +74 -0
  75. data/spec/graphs/engines/bluff_spec.rb +15 -0
  76. data/spec/graphs/engines/gchart_spec.rb +15 -0
  77. data/spec/graphs/flay_grapher_spec.rb +37 -0
  78. data/spec/graphs/flog_grapher_spec.rb +45 -0
  79. data/spec/graphs/rcov_grapher_spec.rb +37 -0
  80. data/spec/graphs/reek_grapher_spec.rb +46 -0
  81. data/spec/graphs/roodi_grapher_spec.rb +37 -0
  82. data/spec/resources/saikuro/app/controllers/sessions_controller.rb_cyclo.html +10 -0
  83. data/spec/resources/saikuro/app/controllers/users_controller.rb_cyclo.html +16 -0
  84. data/spec/resources/saikuro/index_cyclo.html +155 -0
  85. data/spec/resources/saikuro_sfiles/thing.rb_cyclo.html +11 -0
  86. data/spec/resources/yml/20090630.yml +7844 -0
  87. data/spec/spec.opts +8 -0
  88. data/spec/spec_helper.rb +7 -0
  89. data/tasks/metric_fu.rake +22 -0
  90. data/vendor/_fonts/monaco.ttf +0 -0
  91. data/vendor/saikuro/saikuro.rb +1219 -0
  92. metadata +234 -0
data/HISTORY ADDED
@@ -0,0 +1,164 @@
1
+ === MetricFu 1.1.6 / 2009-12-14
2
+
3
+ * Now compatible with Reek 1.2x thanks to Kevin Rutherford
4
+ * Fixed problem with deleted files still showing up in Flog reports thanks to Dan Mayer
5
+
6
+ === MetricFu 1.1.5 / 2009-8-13
7
+
8
+ * Previous Ruby 1.9 fix was not quite fix-y enough
9
+
10
+ === MetricFu 1.1.4 / 2009-7-13
11
+
12
+ * Fixed another Ruby 1.9x bug
13
+
14
+ === MetricFu 1.1.3 / 2009-7-10
15
+
16
+ * MetricFu is now Ruby 1.9x compatible
17
+ * Removed the check for deprecated ways of configuring metric_fu as the tests were causing Ruby 1.9x problems and it's been forever since they were supported.
18
+ * Removed total flog score from graph (which will always go up and so doesn't mean much) and replacing it with top_five_percent_average which is an average of the worst 5 percent of your methods.
19
+ * Sort Flog by highest score in the class which I feel is more important than the total flog flog score.
20
+
21
+ === MetricFu 1.1.2 / 2009-7-09
22
+
23
+ * Removed dependency on gruff and rmagick (unless the user wants graphs, of course).
24
+ * New look for styling -- Edouard Brière
25
+ * Extra param in rcov call was causing problems -- Stewart Welbourne
26
+ * Preventing rake task from being run multiple times when other rake tasks switch the environment -- Matthew Van Horn
27
+ * Typo in Rcov dependency verification and fixing parsing Saikuro nested information -- Mark Wilden
28
+
29
+ === MetricFu 1.1.1 / 2009-6-29
30
+
31
+ * Fix for empty flog files
32
+
33
+ === MetricFu 1.1.0 / 2009-6-22
34
+
35
+ * Flog, flay, reek, roodi, and rcov reports now graph progress over time. Well done Nick Quaranto and Edouard Brière.
36
+ * 'Awesome' template has been brought in so that reports look 90% less 'ghetto.' Also done by Nick Quaranto and Edouard Brière.
37
+ * Added links to TextMate (which keep getting removed. Probably by me. Sorry.) -- David Chelimsky
38
+ * Fixed a bug for scratch files which have a size of 0 -- Kevin Hall
39
+ * Changed gem dependencies from install-time in gemspec to runtime when each of the generators is loaded. This allows use of github gems (i.e. relevance-rcov instead of rcov) and also allows you to install only the gems for the metrics you plan on using. -- Alex Rothenberg
40
+ * Empty Flog file fix -- Adam Bair
41
+ * Added a simple fix for cases where Saikuro results with nested information -- Randy Souza
42
+ * Fixed rcov configuration so it ignores library files on Linux -- Diego Carrion
43
+ * Changing churn so that it still works deeper than the git root directory -- Andrew Timberlake
44
+ * Andrew Timberlake also made some nice changes to the base template which kinda of got overshadowed by the 'awesome' template. Sorry about that Andrew.
45
+
46
+ === MetricFu 1.0.2 / 2009-5-11
47
+
48
+ * Fixing problems with Reek new line character (thanks to all who pointed this out)
49
+ * Flog now recognizes namespaces in method names thanks to Daniel Guettler
50
+ * Saikuro now looks at multiple directories, again.
51
+
52
+ === MetricFu 1.0.1 / 2009-5-3
53
+
54
+ * metrics:all task no longer requires a MetricFu::Configuration.run {} if you want to accept the defaults
55
+ * rcov task now reports total coverage percent
56
+
57
+ === MetricFu 1.0.0 / 2009-4-30
58
+
59
+ * Merged in Grant McInnes' work on creating yaml output for all metrics to aid harvesting by other tools
60
+ * Supporting Flog 2.1.0
61
+ * Supporting Reek 1.0.0
62
+ * Removed dependency on Rails Env for 3.months.ago (for churn report), now using chronic gem ("3 months ago").
63
+ * Almost all code is out of Rakefiles now and so is more easily testable
64
+ * Metrics inherit from a refactored Generator now. New metrics generators just have to implement "emit", "analyze", "to_h" and inherit from Generator. They also must have a template. See the flay generator and template for a simple implementation.
65
+ * You now define the metrics you wish to run in the configuration and then run "metrics:all". No other metrics task is exposed by default.
66
+
67
+ === MetricFu 0.9.0 / 2009-1-25
68
+
69
+ * Adding line numbers to the views so that people viewing it on cc.rb can figure out where the problems are
70
+ * Merging in changes from Jay Zeschin having to do with the railroad task -- I still have no idea how to use it (lemme know if you figure it out)
71
+ * Added totals to Flog results
72
+ * Moved rcov options to configuration
73
+
74
+ === MetricFu 0.8.9 / 2009-1-20
75
+
76
+ * Thanks to Andre Arko and Petrik de Heus for adding the following features:
77
+ * The source control type is auto-detected for Churn
78
+ * Moved all presentation to templates
79
+ * Wrote specs for all classes
80
+ * Added flay, Reek and Roodi metrics
81
+ * There's now a configuration class (see README for details)
82
+ * Unification of metrics reports
83
+ * Metrics can be generated using one command
84
+ * Adding new metrics reports has been standardized
85
+
86
+ === MetricFu 0.8.0 / 2008-10-06
87
+
88
+ * Source Control Churn now supports git (thanks to Erik St Martin)
89
+ * Flog Results are sorted by Highest Flog Score
90
+ * Fix for a bunch of 'already initialized constant' warnings that metric_fu caused
91
+ * Fixing bug so the flog reporter can handle methods with digits in the name (thanks to Andy Gregorowicz)
92
+ * Internal Rake task now allows metric_fu to flog/churn itself
93
+
94
+ === MetricFu 0.7.6 / 2008-09-15
95
+
96
+ * CHURN_OPTIONS has become MetricFu::CHURN_OPTIONS
97
+ * SAIKURO_OPTIONS has become MetricFu::SAIKURO_OPTIONS
98
+ * Rcov now looks at test and specs
99
+ * Exclude gems and Library ruby code from rcov
100
+ * Fixed bug with churn start_date functionality (bad path)
101
+
102
+ === MetricFu 0.7.5 / 2008-09-12
103
+
104
+ * Flog can now flog any set of directories you like (see README).
105
+ * Saikuro can now look at any set of directories you like (see README).
106
+
107
+ === MetricFu 0.7.1 / 2008-09-12
108
+
109
+ * Fixed filename bugs pointed out by Bastien
110
+
111
+ === MetricFu 0.7.0 / 2008-09-11
112
+
113
+ * Merged in Sean Soper's changes to metric_fu.
114
+ * Metric_fu is now a gem.
115
+ * Flogging now uses a MD5 hash to figure out if it should re-flog a file (if it's changed)
116
+ * Flogging also has a cool new output screen(s)
117
+ * Thanks Sean!
118
+
119
+ === Metricks 0.4.2 / 2008-07-01
120
+
121
+ * Changed rcov output directory so that it is no longer 'coverage/unit' but just 'coverage' for better integration with CC.rb
122
+
123
+ === Metricks 0.4.1 / 2008-06-13
124
+
125
+ * Rcov tests now extend beyond one level depth directory by using RcovTask instead of the shell
126
+
127
+ === Metricks 0.4.0 / 2008-06-13
128
+
129
+ * Implementing functionality for use as a gem
130
+ * Added Rakefile to facilitate testing
131
+
132
+ === Metricks 0.3.0 / 2008-06-11
133
+
134
+ * Generated reports now open on darwin automatically
135
+ * Generated reports reside under tmp/metricks unless otherwise specified by ENV['CC_BUILD_ARTIFACTS']
136
+ * MD5Tracker works with Flog reports for speed optimization
137
+
138
+ === Metricks 0.2.0 / 2008-06-11
139
+
140
+ * Integrated use of base directory constant
141
+ * Have all reports automatically open in a browser if platform is darwin
142
+ * Namespaced under Metricks
143
+ * Dropped use of shell md5 command in favor of Ruby's Digest::MD5 libraries
144
+
145
+ === Metricks 0.1.0 / 2008-06-10
146
+
147
+ * Initial integration of metric_fu and my enhancements to flog
148
+ * Metrics are generated but are all over the place
149
+
150
+ === MetricFu 0.6.0 / 2008-05-11
151
+
152
+ * Add source control churn report
153
+
154
+ === MetricFu 0.5.1 / 2008-04-25
155
+
156
+ * Fixed bug with Saikuro report generation
157
+
158
+ === MetricFu 0.5.0 / 2008-04-25
159
+
160
+ * create MetricFu as a Rails Plugin
161
+ * Add Flog Report
162
+ * Add Coverage Report
163
+ * Add Saikuro Report
164
+ * Add Stats Report
@@ -0,0 +1,22 @@
1
+ Copyright (c) 2008,2009 Jake Scruggs
2
+
3
+ Permission is hereby granted, free of charge, to any person
4
+ obtaining a copy of this software and associated documentation
5
+ files (the "Software"), to deal in the Software without
6
+ restriction, including without limitation the rights to use,
7
+ copy, modify, merge, publish, distribute, sublicense, and/or sell
8
+ copies of the Software, and to permit persons to whom the
9
+ Software is furnished to do so, subject to the following
10
+ conditions:
11
+
12
+ The above copyright notice and this permission notice shall be
13
+ included in all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
17
+ OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
19
+ HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
20
+ WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21
+ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22
+ OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,25 @@
1
+ History.txt
2
+ Manifest.txt
3
+ metric_fu-0.7.gem
4
+ metric_fu.gemspec
5
+ MIT-LICENSE
6
+ Rakefile
7
+ README
8
+ TODO.txt
9
+ lib/metric_fu.rb
10
+ lib/metric_fu/base.rb
11
+ lib/metric_fu/churn.rb
12
+ lib/metric_fu/flay_reporter.rb
13
+ lib/metric_fu/flog_reporter.rb
14
+ lib/metric_fu/md5_tracker.rb
15
+ lib/metric_fu/saikuro/saikuro.rb
16
+ lib/metric_fu/saikuro/SAIKURO_README
17
+ lib/tasks/churn.rake
18
+ lib/tasks/coverage.rake
19
+ lib/tasks/flog.rake
20
+ lib/tasks/metric_fu.rake
21
+ lib/tasks/metric_fu.rb
22
+ lib/tasks/saikuro.rake
23
+ lib/tasks/stats.rake
24
+ test/test_helper.rb
25
+ test/test_md5_tracker.rb
@@ -0,0 +1,27 @@
1
+ h1. flyerhzm-metric_fu
2
+
3
+ flyerhzm-metric_fu gem combines metric_fu gem with rails_best_practices gem
4
+
5
+ ***********************************************************************
6
+
7
+ h2. Install
8
+
9
+ <pre><code>
10
+ sudo gem install flyerhzm-metric_fu
11
+ </code></pre>
12
+
13
+ ***********************************************************************
14
+
15
+ h2. Usage
16
+
17
+ 1. make metric_fu gem work in your rails app.
18
+ See metric_fu gem http://metric-fu.rubyforge.org/ for documentation, or the HISTORY file for a change log.
19
+
20
+ 2. change metric_fu gem to flyerhzm_metric_fu gem.
21
+
22
+ <pre><code>
23
+ config.gem 'flyerhzm-metric_fu', :lib => 'metric_fu'
24
+ </code></pre>
25
+
26
+ The usage of flyerhzm-metric_fu gem is the same as metric_fu gem. And you will see rails_best_practices output.
27
+ See rails_best_practices gem http://github.com/flyerhzm/rails_best_practices
@@ -0,0 +1,18 @@
1
+ require 'rake'
2
+ require 'rake/rdoctask'
3
+ require 'spec/rake/spectask'
4
+ require 'lib/metric_fu'
5
+
6
+ desc "Run all specs in spec directory"
7
+ Spec::Rake::SpecTask.new(:spec) do |t|
8
+ t.spec_files = FileList['spec/**/*_spec.rb']
9
+ t.rcov = true
10
+ t.rcov_opts = ['--exclude', 'spec,config,Library,usr/lib/ruby']
11
+ t.rcov_dir = File.join(File.dirname(__FILE__), "tmp")
12
+ end
13
+
14
+ MetricFu::Configuration.run do |config|
15
+ config.template_class = AwesomeTemplate
16
+ end
17
+
18
+ task :default => [:"metrics:all"]
data/TODO ADDED
@@ -0,0 +1,9 @@
1
+ == TODO list
2
+
3
+ * Color code flog results with scale from: http://jakescruggs.blogspot.com/2008/08/whats-good-flog-score.html
4
+ * Integrate Flog, Saikuro, and Coverage into one report so you can see methods that have high complexity and low coverage (this is a big one)
5
+ * Update flog specs so that they actually run flog
6
+ * Add flay specs that run flay
7
+ * Convert readme to markdown and rename to README.mkdn so github will render it
8
+ * Saikuro.rb falls over if tries to parse an empty file. Fair enough. We shouldn't feed it empty files
9
+ * Make running metric_fu on metric_fu less embarrassing
@@ -0,0 +1,145 @@
1
+ module MetricFu
2
+
3
+ # The Template class is intended as an abstract class for concrete
4
+ # template classes to subclass. It provides a variety of utility
5
+ # methods to make templating a bit easier. However, classes do not
6
+ # have to inherit from here in order to provide a template. The only
7
+ # requirement for a template class is that it provides a #write method
8
+ # to actually write out the template. See StandardTemplate for an
9
+ # example.
10
+ class Template
11
+ attr_accessor :report
12
+
13
+ private
14
+ # Creates a new erb evaluated result from the passed in section.
15
+ #
16
+ # @param section String
17
+ # The section name of
18
+ #
19
+ # @return String
20
+ # The erb evaluated string
21
+ def erbify(section)
22
+ require 'erb'
23
+ erb_doc = File.read(template(section))
24
+ ERB.new(erb_doc).result(binding)
25
+ end
26
+
27
+ # Determines whether a template file exists for a given section
28
+ # of the full template.
29
+ #
30
+ # @param section String
31
+ # The section of the template to check against
32
+ #
33
+ # @return Boolean
34
+ # Does a template file exist for this section or not?
35
+ def template_exists?(section)
36
+ File.exist?(template(section))
37
+ end
38
+
39
+ # Copies an instance variable mimicing the name of the section
40
+ # we are trying to render, with a value equal to the passed in
41
+ # constant. Allows the concrete template classes to refer to
42
+ # that instance variable from their ERB rendering
43
+ #
44
+ # @param section String
45
+ # The name of the instance variable to create
46
+ #
47
+ # @param contents Object
48
+ # The value to set as the value of the created instance
49
+ # variable
50
+ def create_instance_var(section, contents)
51
+ instance_variable_set("@#{section}", contents)
52
+ end
53
+
54
+ # Generates the filename of the template file to load and
55
+ # evaluate. In this case, the path to the template directory +
56
+ # the section name + .html.erb
57
+ #
58
+ # @param section String
59
+ # A section of the template to render
60
+ #
61
+ # @return String
62
+ # A file path
63
+ def template(section)
64
+ File.join(this_directory, section.to_s + ".html.erb")
65
+ end
66
+
67
+ # Returns the filename that the template will render into for
68
+ # a given section. In this case, the section name + '.html'
69
+ #
70
+ # @param section String
71
+ # A section of the template to render
72
+ #
73
+ # @return String
74
+ # The output filename
75
+ def output_filename(section)
76
+ section.to_s + ".html"
77
+ end
78
+
79
+ # Returns the contents of a given css file in order to
80
+ # render it inline into a template.
81
+ #
82
+ # @param css String
83
+ # The name of a css file to open
84
+ #
85
+ # @return String
86
+ # The contents of the css file
87
+ def inline_css(css)
88
+ open(File.join(this_directory, css)) { |f| f.read }
89
+ end
90
+
91
+ # Provides a link to open a file through the textmate protocol
92
+ # on Darwin, or otherwise, a simple file link.
93
+ #
94
+ # @param name String
95
+ #
96
+ # @param line Integer
97
+ # The line number to link to, if textmate is available. Defaults
98
+ # to nil
99
+ #
100
+ # @return String
101
+ # An anchor link to a textmate reference or a file reference
102
+ def link_to_filename(name, line = nil, link_content = nil)
103
+ "<a href='#{file_url(name, line)}'>#{link_content(name, line, link_content)}</a>"
104
+ end
105
+
106
+ def link_content(name, line=nil, link_content=nil) # :nodoc:
107
+ if link_content
108
+ link_content
109
+ elsif line
110
+ "#{name}:#{line}"
111
+ else
112
+ name
113
+ end
114
+ end
115
+
116
+ def file_url(name, line) # :nodoc:
117
+ filename = File.expand_path(name.gsub(/^\//, ''))
118
+ if MetricFu.configuration.platform.include?('darwin')
119
+ "txmt://open/?url=file://#{filename}" << (line ? "&line=#{line}" : "")
120
+ else
121
+ "file://#{filename}"
122
+ end
123
+ end
124
+
125
+ # Provides a brain dead way to cycle between two values during
126
+ # an iteration of some sort. Pass in the first_value, the second_value,
127
+ # and the cardinality of the iteration.
128
+ #
129
+ # @param first_value Object
130
+ #
131
+ # @param second_value Object
132
+ #
133
+ # @param iteration Integer
134
+ # The number of times through the iteration.
135
+ #
136
+ # @return Object
137
+ # The first_value if iteration is even. The second_value if
138
+ # iteration is odd.
139
+ def cycle(first_value, second_value, iteration)
140
+ return first_value if iteration % 2 == 0
141
+ return second_value
142
+ end
143
+
144
+ end
145
+ end
@@ -0,0 +1,180 @@
1
+ module MetricFu
2
+
3
+ # A list of metrics which are available in the MetricFu system.
4
+ #
5
+ # These are metrics which have been developed for the system. Of
6
+ # course, in order to use these metrics, their respective gems must
7
+ # be installed on the system.
8
+ AVAILABLE_METRICS = [:churn, :flog, :flay, :reek,
9
+ :roodi, :saikuro, :rcov]
10
+
11
+ AVAILABLE_GRAPHS = [:flog, :flay, :reek, :roodi, :rcov, :rails_best_practices]
12
+ AVAILABLE_GRAPH_ENGINES = [:gchart, :bluff]
13
+
14
+ # The @@configuration class variable holds a global type configuration
15
+ # object for any parts of the system to use.
16
+ def self.configuration
17
+ @@configuration ||= Configuration.new
18
+ end
19
+
20
+ # = Configuration
21
+ #
22
+ # The Configuration class, as it sounds, provides methods for
23
+ # configuring the behaviour of MetricFu.
24
+ #
25
+ # == Customization for Rails
26
+ #
27
+ # The Configuration class checks for the presence of a
28
+ # 'config/environment.rb' file. If the file is present, it assumes
29
+ # it is running in a Rails project. If it is, it will:
30
+ #
31
+ # * Add 'app' to the @code_dirs directory to include the
32
+ # code in the app directory in the processing
33
+ # * Add :stats to the list of metrics to run to get the Rails stats
34
+ # task
35
+ #
36
+ # == Customization for CruiseControl.rb
37
+ #
38
+ # The Configuration class checks for the presence of a
39
+ # 'CC_BUILD_ARTIFACTS' environment variable. If it's found
40
+ # it will change the default output directory from the default
41
+ # "tmp/metric_fu to the directory represented by 'CC_BUILD_ARTIFACTS'
42
+ #
43
+ # == Deprications
44
+ #
45
+ # The Configuration class checks for several deprecated constants
46
+ # that were previously used to configure MetricFu. These include
47
+ # CHURN_OPTIONS, DIRECTORIES_TO_FLOG, SAIKURO_OPTIONS,
48
+ # and MetricFu::SAIKURO_OPTIONS.
49
+ #
50
+ # These have been replaced by config.churn, config.flog and
51
+ # config.saikuro respectively.
52
+ class Configuration
53
+
54
+ def initialize #:nodoc:#
55
+ reset
56
+ add_attr_accessors_to_self
57
+ add_class_methods_to_metric_fu
58
+ end
59
+
60
+ # Searches through the instance variables of the class and
61
+ # creates a class method on the MetricFu module to read the value
62
+ # of the instance variable from the Configuration class.
63
+ def add_class_methods_to_metric_fu
64
+ instance_variables.each do |name|
65
+ method_name = name[1..-1].to_sym
66
+ method = <<-EOF
67
+ def self.#{method_name}
68
+ configuration.send(:#{method_name})
69
+ end
70
+ EOF
71
+ MetricFu.module_eval(method)
72
+ end
73
+ end
74
+
75
+ # Searches through the instance variables of the class and creates
76
+ # an attribute accessor on this instance of the Configuration
77
+ # class for each instance variable.
78
+ def add_attr_accessors_to_self
79
+ instance_variables.each do |name|
80
+ method_name = name[1..-1].to_sym
81
+ MetricFu::Configuration.send(:attr_accessor, method_name)
82
+ end
83
+ end
84
+
85
+ # This allows us to have a nice syntax like:
86
+ #
87
+ # MetricFu.run do |config|
88
+ # config.base_directory = 'tmp/metric_fu'
89
+ # end
90
+ #
91
+ # See the README for more information on configuration options.
92
+ def self.run
93
+ yield MetricFu.configuration
94
+ end
95
+
96
+ # This does the real work of the Configuration class, by setting
97
+ # up a bunch of instance variables to represent the configuration
98
+ # of the MetricFu app.
99
+ def reset
100
+ @base_directory = ENV['CC_BUILD_ARTIFACTS'] || 'tmp/metric_fu'
101
+ @scratch_directory = File.join(@base_directory, 'scratch')
102
+ @output_directory = File.join(@base_directory, 'output')
103
+ @data_directory = File.join('tmp/metric_fu', '_data')
104
+ @metric_fu_root_directory = File.join(File.dirname(__FILE__),
105
+ '..', '..')
106
+ @template_directory = File.join(@metric_fu_root_directory,
107
+ 'lib', 'templates')
108
+ @template_class = AwesomeTemplate
109
+ set_metrics
110
+ set_graphs
111
+ set_code_dirs
112
+ @flay = { :dirs_to_flay => @code_dirs }
113
+ @flog = { :dirs_to_flog => @code_dirs }
114
+ @reek = { :dirs_to_reek => @code_dirs }
115
+ @roodi = { :dirs_to_roodi => @code_dirs }
116
+ @saikuro = { :output_directory => @scratch_directory + '/saikuro',
117
+ :input_directory => @code_dirs,
118
+ :cyclo => "",
119
+ :filter_cyclo => "0",
120
+ :warn_cyclo => "5",
121
+ :error_cyclo => "7",
122
+ :formater => "text"}
123
+ @churn = {}
124
+ @stats = {}
125
+ @rcov = { :test_files => ['test/**/*_test.rb',
126
+ 'spec/**/*_spec.rb'],
127
+ :rcov_opts => ["--sort coverage",
128
+ "--no-html",
129
+ "--text-coverage",
130
+ "--no-color",
131
+ "--profile",
132
+ "--rails",
133
+ "--exclude /gems/,/Library/,/usr/,spec"]}
134
+ @rails_best_practices = {}
135
+
136
+ @file_globs_to_ignore = []
137
+
138
+ @graph_engine = :bluff # can be :bluff or :gchart
139
+ end
140
+
141
+ # Perform a simple check to try and guess if we're running
142
+ # against a rails app.
143
+ #
144
+ # @todo This should probably be made a bit more robust.
145
+ def rails?
146
+ @rails = File.exist?("config/environment.rb")
147
+ end
148
+
149
+ # Add the :stats task to the AVAILABLE_METRICS constant if we're
150
+ # running within rails.
151
+ def set_metrics
152
+ if rails?
153
+ @metrics = MetricFu::AVAILABLE_METRICS + [:stats, :rails_best_practices]
154
+ else
155
+ @metrics = MetricFu::AVAILABLE_METRICS
156
+ end
157
+ end
158
+
159
+ def set_graphs
160
+ @graphs = MetricFu::AVAILABLE_GRAPHS
161
+ end
162
+
163
+ # Add the 'app' directory if we're running within rails.
164
+ def set_code_dirs
165
+ if rails?
166
+ @code_dirs = ['app', 'lib']
167
+ else
168
+ @code_dirs = ['lib']
169
+ end
170
+ end
171
+
172
+ def platform #:nodoc:
173
+ return RUBY_PLATFORM
174
+ end
175
+
176
+ def is_cruise_control_rb?
177
+ !!ENV['CC_BUILD_ARTIFACTS']
178
+ end
179
+ end
180
+ end