MetricFu is a set of tools to provide reports that show which parts of your code might need extra work.
Metrics supported: Cane, Churn, Flog, Flay, Reek, Roodi, Saikuro, Code Statistics, Hotspots, SimpleCov, Rcov, Rails Best Practices (Rails-only).
Run:
$ gem install metric_fu
Or add this line to your application's Gemfile:
gem 'metric_fu'And then execute:
$ bundle
MetricFu is cryptographically signed. To be sure the gem you install hasn't been tampered with:
- Add my public key (if you haven't already) as a trusted certificate
gem cert --add <(curl -Ls https://raw.github.com/metricfu/metric_fu/master/certs/bf4.pem) gem install metric_fu -P MediumSecurity
The MediumSecurity trust profile will verify signed gems, but allow the installation of unsigned dependencies.
This is necessary because not all of MetricFu's dependencies are signed, so we cannot use HighSecurity.
From your application root, run:
$ metric_fu
To see available options run metric_fu --help
MetricFu will attempt to load configuration data from a
.metrics file, if present in your repository root.
MetricFu.report_name # by default, your directory base name
MetricFu.report_name = 'Something Convenient'# To configure individual metrics...
MetricFu::Configuration.run do |config|
config.configure_metric(:cane) do |cane|
cane.enabled = true
cane.abc_max = 15
cane.line_length = 80
cane.no_doc = 'y'
cane.no_readme = 'y'
end
end
# Or, alternative format
MetricFu.configuration.configure_metric(:churn) do |churn|
churn.enabled = true
churn.ignore_files = 'HISTORY.md, TODO.md'
churn.start_date = '6 months ago'
end
# Or, to (re)configure all metrics
MetricFu.configuration.configure_metrics.each do |metric|
if [:churn, :flay, :flog].include?(metric.name)
metric.enabled = true
else
metric.enabled = false
end
endMetricFu::Configuration.run do |config|
config.configure_metric(:rails_best_practices) do |rbp|
rbp.silent = true
rbp.exclude = ["config/chef"]
end
endMetricFu::Configuration.run do |config|
config.configure_metric(:rcov) do |rcov|
rcov.coverage_file = MetricFu.run_path.join("coverage/rcov/rcov.txt")
rcov.enable
rcov.activate
end
endIf you want metric_fu to actually run rcov itself (1.8 only), don't specify an external file to read from
To generate the same metrics metric_fu has been generating run from the root of your project before running metric_fu
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.txtAdd to your Gemfile or otherwise install
gem 'simplecov'Modify your spec_helper as per the SimpleCov docs and run your tests before running metric_fu
#in your spec_helper
require 'simplecov'
require 'metric_fu/metrics/rcov/simplecov_formatter'
SimpleCov.formatter = SimpleCov::Formatter::MetricFu
# or
SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
SimpleCov::Formatter::HTMLFormatter,
SimpleCov::Formatter::MetricFu
]
SimpleCov.startAdditionally, the coverage_file path must be specified as above and must exist.
By default, metric_fu will use the built-in html formatter to generate HTML reports for each metric with pretty graphs.
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
using a relative path:
metric_fu --out custom_directory # outputs to tmp/metric_fu/custom_directoryor a full path:
metric_fu --out $HOME/tmp/metrics # outputs to $HOME/tmp/metricsYou 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.
metric_fu --format yaml --out custom_report.ymlOr in Ruby, such as in your .metrics
# Specify multiple formatters
# The second argument, the output file, is optional
MetricFu::Configuration.run do |config|
config.configure_formatter(:html)
config.configure_formatter(:yaml, "customreport.yml")
config.configure_formatter(:yaml)
endYou can customize metric_fu's output format with a custom formatter.
To create a custom formatter, you simply need to create a class that takes an options hash and responds to one or more notifications:
class MyCustomFormatter
def initialize(opts={}); end # metric_fu will pass in an output param if provided.
# Should include one or more of...
def start; end # Sent before metric_fu starts metric measurements.
def start_metric(metric); end # Sent before individual metric is measured.
def finish_metric(metric); end # Sent after individual metric measurement is complete.
def finish; end # Sent after metric_fu has completed all measurements.
def display_results; end # Used to open results in browser, etc.
endThen
metric_fu --format MyCustomFormatterSee lib/metric_fu/formatter for examples.
MetricFu will attempt to require a custom formatter by fully qualified name based on ruby search path. So if you include a custom formatter as a gem in your Gemfile, you should be able to use it out of the box. But you may find in certain cases that you need to add a require to your .metrics configuration file.
For instance, to require a formatter in your app's lib directory require './lib/my_custom_formatter.rb'
By default, MetricFu uses the Bluff (JavaScript) graph engine.
MetricFu.configuration.configure_graph_engine(:bluff)But you can also use the Highcharts JS library
MetricFu.configuration.configure_graph_engine(:highcharts)Notice: There was previously a :gchart option.
It was not properly deprecated in the 4.x series.
- 'ArgumentError; message invalid byte sequence in US-ASCII' may be caused by having a default external encoding that is not UTF-8. You can see this in the output of
metric_fu --debug- OSX: Ensure you have set
LANG=en_US.UTF-8andLC_ALL=en_US.UTF-8. You can add these to your~/.profile.
- OSX: Ensure you have set
-
It is currently testing on MRI (>= 1.9.3), JRuby (19 mode), and Rubinius (19 mode). Ruby 1.8 is no longer supported.
-
For 1.8.7 support, see version 3.0.0 for partial support, or 2.1.3.7.18.1 (where Semantic Versioning goes to die)
-
MetricFu no longer runs any of the analyzed code. For code coverage, you may use a formatter as documented above
-
The Cane, Flog, and Rails Best Practices metrics are disabled when Ripper is not available
Take a look at our contributing guide. Bug reports and pull requests are welcome on GitHub at https://github.com/metricfu/metric_fu. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Code of Conduct.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent