metric_fu 4.8.0 → 4.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (57) hide show
  1. checksums.yaml +8 -8
  2. checksums.yaml.gz.sig +0 -0
  3. data.tar.gz.sig +0 -0
  4. data/.metrics +1 -66
  5. data/.travis.yml +1 -0
  6. data/CONTRIBUTORS +13 -11
  7. data/DEV.md +21 -18
  8. data/Gemfile +1 -2
  9. data/Gemfile.devtools +0 -1
  10. data/HISTORY.md +7 -1
  11. data/README.md +79 -19
  12. data/Rakefile +0 -1
  13. data/checksum/metric_fu-4.8.0.gem.sha512 +1 -0
  14. data/gem_tasks/usage_test.rake +30 -0
  15. data/lib/metric_fu/configuration.rb +6 -1
  16. data/lib/metric_fu/data_structures/line_numbers.rb +1 -1
  17. data/lib/metric_fu/environment.rb +2 -7
  18. data/lib/metric_fu/logging/mf_debugger.rb +4 -4
  19. data/lib/metric_fu/metric.rb +2 -2
  20. data/lib/metric_fu/metrics/cane/template_awesome/cane.html.erb +74 -85
  21. data/lib/metric_fu/metrics/churn/churn.rb +1 -2
  22. data/lib/metric_fu/metrics/flay/template_awesome/flay.html.erb +2 -1
  23. data/lib/metric_fu/metrics/flog/template_awesome/flog.html.erb +2 -1
  24. data/lib/metric_fu/metrics/rails_best_practices/template_awesome/rails_best_practices.html.erb +2 -1
  25. data/lib/metric_fu/metrics/rcov/external_client.rb +24 -0
  26. data/lib/metric_fu/metrics/rcov/rcov.rb +9 -100
  27. data/lib/metric_fu/metrics/rcov/rcov_format_coverage.rb +140 -0
  28. data/lib/metric_fu/metrics/rcov/simplecov_formatter.rb +64 -0
  29. data/lib/metric_fu/metrics/rcov/template_awesome/rcov.html.erb +5 -1
  30. data/lib/metric_fu/metrics/reek/reek_grapher.rb +7 -1
  31. data/lib/metric_fu/metrics/reek/template_awesome/reek.html.erb +2 -1
  32. data/lib/metric_fu/metrics/roodi/template_awesome/roodi.html.erb +2 -1
  33. data/lib/metric_fu/metrics/stats/template_awesome/stats.html.erb +2 -2
  34. data/lib/metric_fu/reporting/graphs/grapher.rb +5 -20
  35. data/lib/metric_fu/reporting/templates/awesome/awesome_template.rb +1 -1
  36. data/lib/metric_fu/reporting/templates/awesome/layout.html.erb +8 -3
  37. data/lib/metric_fu/reporting/templates/javascripts/bluff_graph.js +15 -0
  38. data/lib/metric_fu/reporting/templates/javascripts/excanvas.js +1 -1
  39. data/lib/metric_fu/reporting/templates/javascripts/highcharts.js +294 -0
  40. data/lib/metric_fu/reporting/templates/javascripts/highcharts_graph.js +38 -0
  41. data/lib/metric_fu/reporting/templates/javascripts/standalone-framework.js +17 -0
  42. data/lib/metric_fu/reporting/templates/javascripts/utils.js +9 -0
  43. data/lib/metric_fu/templates/css/bluff.css +10 -10
  44. data/lib/metric_fu/templates/css/integrity.css +3 -0
  45. data/lib/metric_fu/templates/report.html.erb +3 -4
  46. data/lib/metric_fu/version.rb +1 -1
  47. data/metric_fu.gemspec +1 -0
  48. data/spec/fixtures/coverage.rb +13 -0
  49. data/spec/fixtures/exit0.sh +3 -0
  50. data/spec/fixtures/exit1.sh +3 -0
  51. data/spec/metric_fu/formatter/html_spec.rb +2 -2
  52. data/spec/metric_fu/metrics/rcov/simplecov_formatter_spec.rb +41 -0
  53. data/spec/spec_helper.rb +7 -8
  54. data/spec/support/usage_test.rb +134 -0
  55. data/spec/usage_test_spec.rb +69 -0
  56. metadata +39 -3
  57. metadata.gz.sig +0 -0
checksums.yaml CHANGED
@@ -1,15 +1,15 @@
1
1
  ---
2
2
  !binary "U0hBMQ==":
3
3
  metadata.gz: !binary |-
4
- NmFkZmI2MTJiNGIyYzU2ZWU0ZmVmYTdlZjY3NTc0ZGU2ZGU3MzAxMw==
4
+ YjgwZjBkODQ4YjhmMzJkNWNhZDI1ODllYWI2NzljNmI3MDQ3ZDBiNA==
5
5
  data.tar.gz: !binary |-
6
- NzNmZGNlOTJiYTNiZjVkMGRiNDBkZWNiNDQzNmMwOGEzM2ZiMjliMg==
6
+ N2JkYjFhMDllMzBjMzRiNDMwOTI2MmI5YmFmYzNkOWJlOTAzMzAzNw==
7
7
  SHA512:
8
8
  metadata.gz: !binary |-
9
- NThhOGUyMzhmMGNhOWVlMmJhOTNhNzc4ZjkwNTAyNjlmMzkyNzU3ZDEzOWY3
10
- ZmE2NzIxYWJjY2E2ZmQyYThhYjliZDJkZWViYTYwOTg5MjZkNDFjMzQ5Zjgx
11
- ZjY1MDU4MWNiZTQyYjc3YzE2N2NlZDBmY2U5ZGFiODA4NjAzMDk=
9
+ NDIzNTQ3ZjE1ZDFkYjVkYWY4M2I3NjdjMmExY2MxOTg4ZGZmNzdjYTEzOTU1
10
+ MTEzYjc1ZWNjMGZlOTAzMTNkMzk2YWMwYjRmZjE3MmIxN2I4ZmY2ZGMwYWJk
11
+ NTRlMzQ2YTcxZmVhZDI3MWFiM2E0MTRmMjM0NDQzYmNiZDg3ODE=
12
12
  data.tar.gz: !binary |-
13
- N2VhYjg0YWYwNWY5ZmViYjIxMWZjZGNhNGUzM2M4YjU5NDZlNTM4ZDljMTA5
14
- MWY1NWUwNGI4NjE1MDg2ZmIwZmU1MzdlMDEzYmIzZGFkZGZlN2Y1NWE3NGRj
15
- YjlhYjllYjVjZTRhNjNhN2MxZWQxZmRiNWRlZDMyOWE3YzE0MjQ=
13
+ MjgzZjM4YTUyZTU5M2NmMTkxOWFjYWI5ZGM0NWQzM2Q0M2ZhMjQ4MzllNDc5
14
+ YTMzYTgzNjUyODlmMzQ1YTcwYjc5ZjQxMDcyNzQ0ZWMyMmIzZTFlNzcwODUy
15
+ ZWIwMGI5MzFmZTY1MjkxN2IwZWNlMTg2ODQ2YjUzYWFhNDI4OWM=
checksums.yaml.gz.sig CHANGED
Binary file
data.tar.gz.sig CHANGED
Binary file
data/.metrics CHANGED
@@ -1,68 +1,3 @@
1
1
  #!/usr/bin/env ruby
2
-
3
- # Example Configuration
4
2
  #
5
- # MetricFu::Configuration.run do |config|
6
- #
7
- # # Configure Metrics
8
- #
9
- # # To configure individual metrics...
10
- #
11
- # config.configure_metric(:rcov) do |rcov|
12
- # rcov.coverage_file = MetricFu.run_path.join("coverage/rcov/rcov.txt")
13
- # rcov.enable
14
- # rcov.activate
15
- # end
16
- #
17
- # config.configure_metric(:cane) do |cane|
18
- # cane.enabled = true
19
- # cane.abc_max = 15
20
- # cane.line_length = 80
21
- # cane.no_doc = 'y'
22
- # cane.no_readme = 'y'
23
- # end
24
- #
25
- # config.configure_metric(:churn) do |churn|
26
- # churn.enabled = true
27
- # churn.ignore_files = 'HISTORY.md, TODO.md'
28
- # churn.start_date = '6 months ago'
29
- # end
30
- #
31
- # # Or, to configure a group of metrics...
32
- # config.configure_metrics.each do |metric|
33
- # if [:churn, :flay, :flog].include?(metric.name)
34
- # metric.enabled = true
35
- # else
36
- # metric.enabled = false
37
- # end
38
- # end
39
- #
40
- #
41
- # # Configure Formatters
42
- #
43
- # # By default, metric_fu will use the built-in html formatter
44
- # # to generate HTML reports for each metric with pretty graphs.
45
-
46
- # # To configure different formatter(s) or output ...
47
- #
48
- # config.configure_formatter(:html)
49
- # config.configure_formatter(:yaml, "customreport.yml")
50
- # config.configure_formatter(MyCustomFormatter)
51
- #
52
- # # MetricFu will attempt to require a custom formatter by
53
- # # fully qualified name based on ruby search path,
54
- # # but you may find that you need to add a require above.
55
- #
56
- # # For instance, to require a formatter in your app's lib directory, add the
57
- # # following line to the top of this file.
58
- # # require './lib/my_custom_formatter.rb'
59
- #
60
- #
61
- # # Configure Graph Engine
62
- #
63
- # # By default, metric_fu uses the bluff graph engine.
64
- # # To configure a different graph engine...
65
- #
66
- # # config.configure_graph_engine(:gchart)
67
- #
68
- # end
3
+ # Put configuration code here
data/.travis.yml CHANGED
@@ -6,6 +6,7 @@ gemfile:
6
6
  - gemfiles/Gemfile.travis
7
7
  before_install:
8
8
  - gem install bundler
9
+ - bundle config --local without local_development
9
10
  # env:
10
11
  # - "rack=1.3.4"
11
12
  rvm:
data/CONTRIBUTORS CHANGED
@@ -10,10 +10,11 @@ Sean Soper
10
10
  Delwyn de Villiers
11
11
  Carl Youngblood
12
12
  Andre Arko
13
+ Martin Gotink
13
14
  Chris Griego
14
15
  Sathish
15
- Nick Quaranto
16
16
  Michael Stark
17
+ Nick Quaranto
17
18
  dan sinclair
18
19
  joshuacronemeyer
19
20
  jscruggs
@@ -29,10 +30,11 @@ GeorgeErickson
29
30
  Josef Šimánek
30
31
  Andy Gregorowicz
31
32
  Tarsoly András
33
+ Benjamin Fleischer / Paul Swagerty
32
34
  unknown
33
35
  Extrovert
34
- KAKUTANI Shintaro
35
36
  Andrew Timberlake
37
+ KAKUTANI Shintaro
36
38
  Guilherme Souza
37
39
  Przemysław Dąbek
38
40
  carlost
@@ -40,30 +42,30 @@ David Barri
40
42
  Beau Fabry
41
43
  Chris Mason
42
44
  Andrew Selder
43
- iain
44
45
  Mark Wilden
46
+ iain
45
47
  Lars E. Hoeg
46
48
  Eric Wollesen
47
49
  Adam Bair
48
50
  Jinzhu
49
51
  Matthew Van Horn
50
- Martin Gotink
51
52
  Diego Carrion
52
53
  benlovell
53
54
  saltracer
54
55
  ff-cviradiya
55
56
  khall
56
- Stefan Huber
57
57
  Todd A. Jacobs
58
- jayzes
59
- Scyllinice
60
- Hans Hasselberg
58
+ Stefan Huber
61
59
  Bitdeli Chef
60
+ Hans Hasselberg
61
+ Scyllinice
62
+ jayzes
62
63
  Matthew Gordon
63
- Chris Ian Fiel
64
64
  factorylabs
65
65
  Paul Elliott
66
- Greg Allen
66
+ Guilherme Simões
67
+ René Föhring
68
+ Chris Ian Fiel
67
69
  Joel Nimety
68
70
  Mike Ball
69
- Guilherme Simões
71
+ Greg Allen
data/DEV.md CHANGED
@@ -2,37 +2,39 @@
2
2
 
3
3
  ```ruby
4
4
  MetricFu.run_dir #=> Dir.pwd
5
- MetricFu.run_dir = some_path
5
+ MetricFu.run_dir = 'some_path'
6
6
  MetricFu.run_path #=> Pathname(Dir.pwd)
7
7
  MetricFu.root_dir
8
- MetricFu.load_user_configuration
8
+ MetricFu.loader.load_user_configuration
9
9
  MetricFu.loader.loaded_files
10
- MetricFu.lib_require(base = '',&block)
10
+ MetricFu.lib_require { 'utility' }
11
11
  MetricFu.lib_dir #=> metric_fu/lib
12
- MetricFu.metrics_require(&block)
12
+ MetricFu.lib_require('metrics') { 'flog/init' }
13
+ MetricFu.metrics_require {'flog/init' }
13
14
  MetricFu.metrics_dir #=> metric_fu/lib/metrics
14
- MetricFu.formatter_require(&block)
15
+ MetricFu.formatter_require { 'html' }
15
16
  MetricFu.formatter_dir #=> metric_fu/lib/formatter
16
- MetricFu.reporting_require(&block)
17
+ MetricFu.reporting_require { 'result' }
17
18
  MetricFu.reporting_dir #=> metric_fu/lib/reporting
18
- MetricFu.logging_require(&block)
19
+ MetricFu.logging_require { 'mf_debugger' }
19
20
  MetricFu.logging_dir #=> metric_fu/lib/logging
20
- MetricFu.errors_require(&block)
21
+ MetricFu.errors_require { 'analysis_error' }
21
22
  MetricFu.errors_dir #=> metric_fu/lib/errors
22
- MetricFu.data_structures_require(&block)
23
+ MetricFu.data_structures_require { 'line_numbers' }
23
24
  MetricFu.data_structures_dir #=> metric_fu/lib/data_structures
24
- MetricFu.tasks_require(&block)
25
+ MetricFu.tasks_require { } # Doesn't work as expected. Don't use
25
26
  MetricFu.tasks_dir #=> metric_fu/lib/tasks
26
27
 
27
28
  MetricFu.configuration #=> MetricFu::Configuration.new
28
- MetricFu.configuration.configure_metrics # for each metric, yield to block or runs enable, activate
29
- metric = MetricFu.configuration.configure_metric(:flog)
30
- metric.run_options #=> metric.default_run_options.merge(metric.configured_run_options)
31
- metric.enable
32
- metric.enabled = true
33
- metric.activate
34
- metric.activated = true
35
- metric.name #=> :flog
29
+ MetricFu.configuration.configure_metrics # for each metric, yield to block or runs enable, activate
30
+ MetricFu.configuration.configure_metric(:flog) do |metric|
31
+ metric.run_options #=> metric.default_run_options.merge(metric.configured_run_options)
32
+ metric.enable
33
+ metric.enabled = true
34
+ metric.activate
35
+ metric.activated = true
36
+ metric.name #=> :flog
37
+ end
36
38
  ```
37
39
 
38
40
  ## Testing
@@ -51,6 +53,7 @@ metric.name #=> :flog
51
53
 
52
54
  ## Releasing
53
55
 
56
+ 0. Run `rake usage_test` to make sure the examples are still valid
54
57
  1. Update lib/metric_fu/version.rb
55
58
  2. Update HISTORY.md
56
59
  3. `rake release`
data/Gemfile CHANGED
@@ -4,8 +4,7 @@ source 'https://rubygems.org'
4
4
  group :test, :local_development do
5
5
  gem 'pry'
6
6
  gem 'pry-nav'
7
- # https://github.com/kina/simplecov-rcov-text
8
- gem 'simplecov-rcov-text', group: :metrics
7
+ gem 'redcarpet', :platforms => :ruby
9
8
  end
10
9
 
11
10
  gemspec :path => File.expand_path('..', __FILE__)
data/Gemfile.devtools CHANGED
@@ -30,7 +30,6 @@ end
30
30
 
31
31
  group :metrics do
32
32
  # gem 'rubocop', '~> 0.14.1'
33
- gem 'simplecov', '~> 0.7.1'
34
33
  end
35
34
 
36
35
  platform :jruby do
data/HISTORY.md CHANGED
@@ -4,13 +4,19 @@ Each change should fall into categories that would affect whether the release is
4
4
 
5
5
  As such, a _Feature_ would map to either major or minor. A _bug fix_ to a patch. And _misc_ is either minor or patch, the difference being kind of fuzzy for the purposes of history. Adding tests would be patch level.
6
6
 
7
- ### Master [changes](https://github.com/metricfu/metric_fu/compare/v4.8.0...master)
7
+ ### Master [changes](https://github.com/metricfu/metric_fu/compare/v4.9.0...master)
8
8
 
9
9
  * Breaking Changes
10
10
  * Features
11
11
  * Fixes
12
12
  * Misc
13
13
 
14
+ ### [4.9.0 / 2014-03-23](https://github.com/metricfu/metric_fu/compare/v4.8.0...v4.9.0)
15
+
16
+ * Features
17
+ * Add SimpleCov::Formatter::MetricFu, compatible with legacy RCov format (Benjamin Fleischer with h/t Michael @kina, #201)
18
+ * Add Highcharts JS as available graphing engine (Martin Gotink, #205)
19
+
14
20
  ### [4.8.0 / 2014-02-24](https://github.com/metricfu/metric_fu/compare/v4.7.4...v4.8.0)
15
21
 
16
22
  * Features
data/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # MetricFu [![Gem Version](https://badge.fury.io/rb/metric_fu.png)](http://badge.fury.io/rb/metric_fu) [![Build Status](https://travis-ci.org/metricfu/metric_fu.png?branch=master)](http://travis-ci.org/metricfu/metric_fu)
2
2
 
3
- [![Code Climate](https://codeclimate.com/github/metricfu/metric_fu.png)](https://codeclimate.com/github/metricfu/metric_fu) [![Dependency Status](https://gemnasium.com/metricfu/metric_fu.png)](https://gemnasium.com/metricfu/metric_fu)
3
+ [![Code Climate](https://codeclimate.com/github/metricfu/metric_fu.png)](https://codeclimate.com/github/metricfu/metric_fu) [![Inline docs](http://inch-pages.github.io/github/metricfu/metric_fu.png)](http://inch-pages.github.io/github/metricfu/metric_fu) [![Dependency Status](https://gemnasium.com/metricfu/metric_fu.png)](https://gemnasium.com/metricfu/metric_fu)
4
4
 
5
5
  [Rdoc](http://rdoc.info/github/metricfu/metric_fu/)
6
6
 
@@ -31,7 +31,6 @@ metric_fu
31
31
 
32
32
  See:
33
33
  - `metric_fu --help` for more options
34
- - the [.metrics file](https://github.com/metricfu/metric_fu/blob/master/.metrics)
35
34
  - Documentation and Compatibility below
36
35
  - There is also a [wiki page of user-maintained usage information](https://github.com/metricfu/metric_fu/wiki#usage)
37
36
 
@@ -49,13 +48,52 @@ See:
49
48
  ## Documentation
50
49
 
51
50
 
51
+ MetricFu will attempt to load configuration data from a
52
+ `.metrics` file, if present in your repository root.
53
+
54
+ ```ruby
55
+ MetricFu.report_name # by default, your directory base name
56
+ MetricFu.report_name = 'Something Convenient'
57
+ ```
58
+
59
+ ### Example Configuration
60
+
61
+ ```ruby
62
+ # To configure individual metrics...
63
+ MetricFu::Configuration.run do |config|
64
+ config.configure_metric(:cane) do |cane|
65
+ cane.enabled = true
66
+ cane.abc_max = 15
67
+ cane.line_length = 80
68
+ cane.no_doc = 'y'
69
+ cane.no_readme = 'y'
70
+ end
71
+ end
72
+
73
+ # Or, alternative format
74
+ MetricFu.configuration.configure_metric(:churn) do |churn|
75
+ churn.enabled = true
76
+ churn.ignore_files = 'HISTORY.md, TODO.md'
77
+ churn.start_date = '6 months ago'
78
+ end
79
+
80
+ # Or, to (re)configure all metrics
81
+ MetricFu.configuration.configure_metrics.each do |metric|
82
+ if [:churn, :flay, :flog].include?(metric.name)
83
+ metric.enabled = true
84
+ else
85
+ metric.enabled = false
86
+ end
87
+ end
88
+ ```
89
+
52
90
  ## Formatters
53
91
 
54
92
  ### Built-in Formatters
55
93
 
56
94
  By default, metric_fu will use the built-in html formatter to generate HTML reports for each metric with pretty graphs.
57
95
 
58
- These reports are generated in metric_fu's output directory (```tmp/metric_fu/output```) by default. You can customize the output directory by specifying an out directory at the command line
96
+ These reports are generated in metric_fu's output directory (`tmp/metric_fu/output`) by default. You can customize the output directory by specifying an out directory at the command line
59
97
  using a relative path:
60
98
 
61
99
  ```sh
@@ -65,7 +103,7 @@ metric_fu --out custom_directory # outputs to tmp/metric_fu/custom_directory
65
103
  or a full path:
66
104
 
67
105
  ```sh
68
- metric_fu --out /home/metrics # outputs to /home/metrics
106
+ metric_fu --out $HOME/tmp/metrics # outputs to $HOME/tmp/metrics
69
107
  ```
70
108
 
71
109
  You can specify a different formatter at the command line by referencing a built-in formatter or providing the fully-qualified name of a custom formatter.
@@ -75,10 +113,16 @@ You can specify a different formatter at the command line by referencing a built
75
113
  metric_fu --format yaml --out custom_report.yml
76
114
  ```
77
115
 
78
- or
116
+ Or in Ruby, such as in your `.metrics`
79
117
 
80
- ```sh
81
- metric_fu --format MyCustomFormatter
118
+ ```ruby
119
+ # Specify multiple formatters
120
+ # The second argument, the output file, is optional
121
+ MetricFu::Configuration.run do |config|
122
+ config.configure_formatter(:html)
123
+ config.configure_formatter(:yaml, "customreport.yml")
124
+ config.configure_formatter(:yaml)
125
+ end
82
126
  ```
83
127
 
84
128
  ### Custom Formatters
@@ -101,20 +145,39 @@ class MyCustomFormatter
101
145
  end
102
146
  ```
103
147
 
148
+ Then
149
+
150
+ ```shell
151
+ metric_fu --format MyCustomFormatter
152
+ ```
153
+
104
154
  See [lib/metric_fu/formatter/](lib/metric_fu/formatter/) for examples.
105
155
 
106
- metric_fu will attempt to require a custom formatter by
156
+ MetricFu will attempt to require a custom formatter by
107
157
  fully qualified name based on ruby search path. So if you include a custom
108
158
  formatter as a gem in your Gemfile, you should be able to use it out of the box.
109
159
  But you may find in certain cases that you need to add a require to
110
160
  your .metrics configuration file.
111
161
 
112
- For instance, to require a formatter in your app's lib directory:
162
+ For instance, to require a formatter in your app's lib directory `require './lib/my_custom_formatter.rb'`
163
+
164
+ ## Configure Graph Engine
165
+
166
+ By default, MetricFu uses the Bluff (JavaScript) graph engine.
167
+
168
+ ```ruby
169
+ MetricFu.configuration.configure_graph_engine(:bluff)
170
+ ```
171
+
172
+ But it you may also use the [Highcharts JS library](http://shop.highsoft.com/highcharts.html)
113
173
 
114
174
  ```ruby
115
- require './lib/my_custom_formatter.rb'
175
+ MetricFu.configuration.configure_graph_engine(:highcharts)
116
176
  ```
117
177
 
178
+ Notice: There was previously a :gchart option.
179
+ It was not properly deprecated in the 4.x series.
180
+
118
181
  ### Using Coverage Metrics
119
182
 
120
183
  in your .metrics file add the below to run pre-generated metrics
@@ -135,7 +198,7 @@ If you want metric_fu to actually run rcov itself (1.8 only), don't specify an e
135
198
 
136
199
  To generate the same metrics metric_fu has been generating run from the root of your project before running metric_fu
137
200
 
138
- ```sh
201
+ ```shell
139
202
  RAILS_ENV=test rcov $(ruby -e "puts Dir['{spec,test}/**/*_{spec,test}.rb'].join(' ')") --sort coverage --no-html --text-coverage --no-color --profile --exclude-only '.*' --include-file "\Aapp,\Alib" -Ispec > coverage/rcov/rcov.txt
140
203
  ```
141
204
 
@@ -145,8 +208,6 @@ Add to your Gemfile or otherwise install
145
208
 
146
209
  ```ruby
147
210
  gem 'simplecov'
148
- # https://github.com/kina/simplecov-rcov-text
149
- gem 'simplecov-rcov-text'
150
211
  ```
151
212
 
152
213
  Modify your [spec_helper](https://github.com/metricfu/metric_fu/blob/master/spec/spec_helper.rb) as per the SimpleCov docs and run your tests before running metric_fu
@@ -154,12 +215,12 @@ Modify your [spec_helper](https://github.com/metricfu/metric_fu/blob/master/spec
154
215
  ```ruby
155
216
  #in your spec_helper
156
217
  require 'simplecov'
157
- require 'simplecov-rcov-text'
158
- SimpleCov.formatter = SimpleCov::Formatter::RcovTextFormatter
218
+ require 'metric_fu/metrics/rcov/simplecov_formatter'
219
+ SimpleCov.formatter = SimpleCov::Formatter::MetricFu
159
220
  # or
160
221
  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
161
222
  SimpleCov::Formatter::HTMLFormatter,
162
- SimpleCov::Formatter::RcovTextFormatter
223
+ SimpleCov::Formatter::MetricFu
163
224
  ]
164
225
  SimpleCov.start
165
226
  ```
@@ -173,7 +234,7 @@ and must exist.
173
234
 
174
235
  * For 1.8.7 support, see version 3.0.0 for partial support, or 2.1.3.7.18.1 (where [Semantic Versioning](http://semver.org/) goes to die)
175
236
 
176
- * MetricFu no longer runs any of the analyzed code. For code coverage, You may still use rcov metrics as documented above
237
+ * MetricFu no longer runs any of the analyzed code. For code coverage, you may use a formatter as documented above
177
238
 
178
239
  * The Cane, Flog, and Rails Best Practices metrics are disabled when Ripper is not available
179
240
 
@@ -203,7 +264,7 @@ This is the official repository for metric_fu. The original repository by Jake
203
264
  * Rails-only
204
265
  * [Rails Best Practices](https://rubygems.org/gems/rails_best_practices), [Source](https://github.com/railsbp/rails_best_practices)
205
266
  * Test Coverage
206
- * 1.9: [SimpleCov](http://rubygems.org/gems/simplecov) and [SimpleCov-Rcov-Text](http://rubygems.org/gems/simplecov-rcov-text)
267
+ * 1.9: [SimpleCov](http://rubygems.org/gems/simplecov) and SimpleCov::Formatter::MetricFu
207
268
  * 1.8: [Rcov](http://rubygems.org/gems/rcov)
208
269
  * Hotspots (a meta-metric of the above)
209
270
 
@@ -218,4 +279,3 @@ This is the official repository for metric_fu. The original repository by Jake
218
279
 
219
280
 
220
281
  [![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/metricfu/metric_fu/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
221
-