metric_fu 4.8.0 → 4.9.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NmFkZmI2MTJiNGIyYzU2ZWU0ZmVmYTdlZjY3NTc0ZGU2ZGU3MzAxMw==
+    YjgwZjBkODQ4YjhmMzJkNWNhZDI1ODllYWI2NzljNmI3MDQ3ZDBiNA==
   data.tar.gz: !binary |-
-    NzNmZGNlOTJiYTNiZjVkMGRiNDBkZWNiNDQzNmMwOGEzM2ZiMjliMg==
+    N2JkYjFhMDllMzBjMzRiNDMwOTI2MmI5YmFmYzNkOWJlOTAzMzAzNw==
 SHA512:
   metadata.gz: !binary |-
-    NThhOGUyMzhmMGNhOWVlMmJhOTNhNzc4ZjkwNTAyNjlmMzkyNzU3ZDEzOWY3
-    ZmE2NzIxYWJjY2E2ZmQyYThhYjliZDJkZWViYTYwOTg5MjZkNDFjMzQ5Zjgx
-    ZjY1MDU4MWNiZTQyYjc3YzE2N2NlZDBmY2U5ZGFiODA4NjAzMDk=
+    NDIzNTQ3ZjE1ZDFkYjVkYWY4M2I3NjdjMmExY2MxOTg4ZGZmNzdjYTEzOTU1
+    MTEzYjc1ZWNjMGZlOTAzMTNkMzk2YWMwYjRmZjE3MmIxN2I4ZmY2ZGMwYWJk
+    NTRlMzQ2YTcxZmVhZDI3MWFiM2E0MTRmMjM0NDQzYmNiZDg3ODE=
   data.tar.gz: !binary |-
-    N2VhYjg0YWYwNWY5ZmViYjIxMWZjZGNhNGUzM2M4YjU5NDZlNTM4ZDljMTA5
-    MWY1NWUwNGI4NjE1MDg2ZmIwZmU1MzdlMDEzYmIzZGFkZGZlN2Y1NWE3NGRj
-    YjlhYjllYjVjZTRhNjNhN2MxZWQxZmRiNWRlZDMyOWE3YzE0MjQ=
+    MjgzZjM4YTUyZTU5M2NmMTkxOWFjYWI5ZGM0NWQzM2Q0M2ZhMjQ4MzllNDc5
+    YTMzYTgzNjUyODlmMzQ1YTcwYjc5ZjQxMDcyNzQ0ZWMyMmIzZTFlNzcwODUy
+    ZWIwMGI5MzFmZTY1MjkxN2IwZWNlMTg2ODQ2YjUzYWFhNDI4OWM=

data/.metrics

@@ -1,68 +1,3 @@
 #!/usr/bin/env ruby
-
-# Example Configuration
 #
-# MetricFu::Configuration.run do |config|
-#
-#   # Configure Metrics
-#
-#   # To configure individual metrics...
-#
-#   config.configure_metric(:rcov) do |rcov|
-#     rcov.coverage_file = MetricFu.run_path.join("coverage/rcov/rcov.txt")
-#     rcov.enable
-#     rcov.activate
-#   end
-#
-#   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
-# 
-#   config.configure_metric(:churn) do |churn|
-#     churn.enabled = true
-#     churn.ignore_files = 'HISTORY.md, TODO.md'
-#     churn.start_date = '6 months ago'
-#   end
-#
-#   # Or, to configure a group of metrics...
-#   config.configure_metrics.each do |metric|
-#     if [:churn, :flay, :flog].include?(metric.name)
-#       metric.enabled = true
-#     else
-#       metric.enabled = false
-#     end
-#   end
-#
-#
-#   # Configure Formatters
-#
-#   # By default, metric_fu will use the built-in html formatter
-#   # to generate HTML reports for each metric with pretty graphs.
-
-#   # To configure different formatter(s) or output ...
-#
-#   config.configure_formatter(:html)
-#   config.configure_formatter(:yaml, "customreport.yml")
-#   config.configure_formatter(MyCustomFormatter)
-#
-#   # MetricFu will attempt to require a custom formatter by
-#   # fully qualified name based on ruby search path,
-#   # but you may find that you need to add a require above.
-#
-#   # For instance, to require a formatter in your app's lib directory, add the
-#   # following line to the top of this file.
-#   # require './lib/my_custom_formatter.rb'
-#
-#
-#   # Configure Graph Engine
-#
-#   # By default, metric_fu uses the bluff graph engine.
-#   # To configure a different graph engine...
-#
-#   # config.configure_graph_engine(:gchart)
-#
-# end
+# Put configuration code here

data/.travis.yml

@@ -6,6 +6,7 @@ gemfile:
   - gemfiles/Gemfile.travis
 before_install:
   - gem install bundler
+  - bundle config --local without local_development
 # env:
 #   - "rack=1.3.4"
 rvm:

data/CONTRIBUTORS

@@ -10,10 +10,11 @@ Sean Soper
 Delwyn de Villiers
 Carl Youngblood
 Andre Arko
+Martin Gotink
 Chris Griego
 Sathish
-Nick Quaranto
 Michael Stark
+Nick Quaranto
 dan sinclair
 joshuacronemeyer
 jscruggs
@@ -29,10 +30,11 @@ GeorgeErickson
 Josef Šimánek
 Andy Gregorowicz
 Tarsoly András
+Benjamin Fleischer / Paul Swagerty
 unknown
 Extrovert
-KAKUTANI Shintaro
 Andrew Timberlake
+KAKUTANI Shintaro
 Guilherme Souza
 Przemysław Dąbek
 carlost
@@ -40,30 +42,30 @@ David Barri
 Beau Fabry
 Chris Mason
 Andrew Selder
-iain
 Mark Wilden
+iain
 Lars E. Hoeg
 Eric Wollesen
 Adam Bair
 Jinzhu
 Matthew Van Horn
-Martin Gotink
 Diego Carrion
 benlovell
 saltracer
 ff-cviradiya
 khall
-Stefan Huber
 Todd A. Jacobs
-jayzes
-Scyllinice
-Hans Hasselberg
+Stefan Huber
 Bitdeli Chef
+Hans Hasselberg
+Scyllinice
+jayzes
 Matthew Gordon
-Chris Ian Fiel
 factorylabs
 Paul Elliott
-Greg Allen
+Guilherme Simões
+René Föhring
+Chris Ian Fiel
 Joel Nimety
 Mike Ball
-Guilherme Simões
+Greg Allen

data/DEV.md

@@ -2,37 +2,39 @@
 
 ```ruby
 MetricFu.run_dir #=> Dir.pwd
-MetricFu.run_dir = some_path
+MetricFu.run_dir = 'some_path'
 MetricFu.run_path #=> Pathname(Dir.pwd)
 MetricFu.root_dir
-MetricFu.load_user_configuration
+MetricFu.loader.load_user_configuration
 MetricFu.loader.loaded_files
-MetricFu.lib_require(base = '',&block)
+MetricFu.lib_require { 'utility' }
 MetricFu.lib_dir #=> metric_fu/lib
-MetricFu.metrics_require(&block)
+MetricFu.lib_require('metrics')  { 'flog/init' }
+MetricFu.metrics_require {'flog/init' }
 MetricFu.metrics_dir #=> metric_fu/lib/metrics
-MetricFu.formatter_require(&block)
+MetricFu.formatter_require { 'html' }
 MetricFu.formatter_dir #=> metric_fu/lib/formatter
-MetricFu.reporting_require(&block)
+MetricFu.reporting_require { 'result' }
 MetricFu.reporting_dir #=> metric_fu/lib/reporting
-MetricFu.logging_require(&block)
+MetricFu.logging_require { 'mf_debugger' }
 MetricFu.logging_dir   #=> metric_fu/lib/logging
-MetricFu.errors_require(&block)
+MetricFu.errors_require { 'analysis_error' }
 MetricFu.errors_dir    #=> metric_fu/lib/errors
-MetricFu.data_structures_require(&block)
+MetricFu.data_structures_require { 'line_numbers' }
 MetricFu.data_structures_dir #=> metric_fu/lib/data_structures
-MetricFu.tasks_require(&block)
+MetricFu.tasks_require { } # Doesn't work as expected. Don't use
 MetricFu.tasks_dir           #=> metric_fu/lib/tasks
 
 MetricFu.configuration #=> MetricFu::Configuration.new
-MetricFu.configuration.configure_metrics # for each metric, yield to block or runs enable, activate 
-metric = MetricFu.configuration.configure_metric(:flog)
-metric.run_options #=> metric.default_run_options.merge(metric.configured_run_options)
-metric.enable
-metric.enabled = true
-metric.activate
-metric.activated = true
-metric.name #=> :flog
+MetricFu.configuration.configure_metrics # for each metric, yield to block or runs enable, activate
+MetricFu.configuration.configure_metric(:flog) do |metric|
+  metric.run_options #=> metric.default_run_options.merge(metric.configured_run_options)
+  metric.enable
+  metric.enabled = true
+  metric.activate
+  metric.activated = true
+  metric.name #=> :flog
+end
 ```
 
 ## Testing
@@ -51,6 +53,7 @@ metric.name #=> :flog
 
 ## Releasing
 
+0. Run `rake usage_test` to make sure the examples are still valid
 1. Update lib/metric_fu/version.rb
 2. Update HISTORY.md
 3. `rake release`

data/Gemfile

@@ -4,8 +4,7 @@ source 'https://rubygems.org'
 group :test, :local_development  do
   gem 'pry'
   gem 'pry-nav'
-  # https://github.com/kina/simplecov-rcov-text
-  gem 'simplecov-rcov-text', group: :metrics
+  gem 'redcarpet', :platforms => :ruby
 end
 
 gemspec :path => File.expand_path('..', __FILE__)

data/Gemfile.devtools

@@ -30,7 +30,6 @@ end
 
 group :metrics do
   # gem 'rubocop',   '~> 0.14.1'
-  gem 'simplecov', '~> 0.7.1'
 end
 
 platform :jruby do

data/HISTORY.md

@@ -4,13 +4,19 @@ Each change should fall into categories that would affect whether the release is
 
 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.
 
-### Master [changes](https://github.com/metricfu/metric_fu/compare/v4.8.0...master)
+### Master [changes](https://github.com/metricfu/metric_fu/compare/v4.9.0...master)
 
 * Breaking Changes
 * Features
 * Fixes
 * Misc
 
+### [4.9.0 / 2014-03-23](https://github.com/metricfu/metric_fu/compare/v4.8.0...v4.9.0)
+
+* Features
+  * Add SimpleCov::Formatter::MetricFu, compatible with legacy RCov format (Benjamin Fleischer with h/t Michael @kina, #201)
+  * Add Highcharts JS as available graphing engine (Martin Gotink, #205)
+
 ### [4.8.0 / 2014-02-24](https://github.com/metricfu/metric_fu/compare/v4.7.4...v4.8.0)
 
 * Features

data/README.md

@@ -1,6 +1,6 @@
 # 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)
 
-[![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)
+[![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)
 
 [Rdoc](http://rdoc.info/github/metricfu/metric_fu/)
 
@@ -31,7 +31,6 @@ metric_fu
 
 See:
 - `metric_fu --help` for more options
-- the [.metrics file](https://github.com/metricfu/metric_fu/blob/master/.metrics)
 - Documentation and Compatibility below
 - There is also a [wiki page of user-maintained usage information](https://github.com/metricfu/metric_fu/wiki#usage)
 
@@ -49,13 +48,52 @@ See:
 ## Documentation
 
 
+MetricFu will attempt to load configuration data from a
+`.metrics` file, if present in your repository root.
+
+```ruby
+MetricFu.report_name # by default, your directory base name
+MetricFu.report_name = 'Something Convenient'
+```
+
+### Example Configuration
+
+```ruby
+# 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
+end
+```
+
 ## Formatters
 
 ### Built-in Formatters
 
 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
+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:
 
 ```sh
@@ -65,7 +103,7 @@ metric_fu --out custom_directory    # outputs to tmp/metric_fu/custom_directory
 or a full path:
 
 ```sh
-metric_fu --out /home/metrics      # outputs to /home/metrics
+metric_fu --out $HOME/tmp/metrics      # outputs to $HOME/tmp/metrics
 ```
 
 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
 metric_fu --format yaml --out custom_report.yml
 ```
 
-or
+Or in Ruby, such as in your `.metrics`
 
-```sh
-metric_fu --format MyCustomFormatter
+```ruby
+# 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)
+end
 ```
 
 ### Custom Formatters
@@ -101,20 +145,39 @@ class MyCustomFormatter
 end
 ```
 
+Then
+
+```shell
+metric_fu --format MyCustomFormatter
+```
+
 See [lib/metric_fu/formatter/](lib/metric_fu/formatter/) for examples.
 
-metric_fu will attempt to require a custom formatter by
+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:
+For instance, to require a formatter in your app's lib directory `require './lib/my_custom_formatter.rb'`
+
+##  Configure Graph Engine
+
+By default, MetricFu uses the Bluff (JavaScript) graph engine.
+
+```ruby
+MetricFu.configuration.configure_graph_engine(:bluff)
+```
+
+But it you may also use the [Highcharts JS library](http://shop.highsoft.com/highcharts.html)
 
 ```ruby
-require './lib/my_custom_formatter.rb'
+MetricFu.configuration.configure_graph_engine(:highcharts)
 ```
 
+Notice: There was previously a :gchart option.
+It was not properly deprecated in the 4.x series.
+
 ### Using Coverage Metrics
 
 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
 
 To generate the same metrics metric_fu has been generating run from the root of your project before running metric_fu
 
-```sh
+```shell
 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
 ```
 
@@ -145,8 +208,6 @@ Add to your Gemfile or otherwise install
 
 ```ruby
 gem 'simplecov'
-# https://github.com/kina/simplecov-rcov-text
-gem 'simplecov-rcov-text'
 ```
 
 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
 ```ruby
 #in your spec_helper
 require 'simplecov'
-require 'simplecov-rcov-text'
-SimpleCov.formatter = SimpleCov::Formatter::RcovTextFormatter
+require 'metric_fu/metrics/rcov/simplecov_formatter'
+SimpleCov.formatter = SimpleCov::Formatter::MetricFu
 # or
 SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
   SimpleCov::Formatter::HTMLFormatter,
-  SimpleCov::Formatter::RcovTextFormatter
+  SimpleCov::Formatter::MetricFu
   ]
 SimpleCov.start
 ```
@@ -173,7 +234,7 @@ and must exist.
 
 * 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)
 
-* MetricFu  no longer runs any of the analyzed code. For code coverage, You may still use rcov metrics as documented above
+* 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
 
@@ -203,7 +264,7 @@ This is the official repository for metric_fu.  The original repository by Jake
 * Rails-only
   * [Rails Best Practices](https://rubygems.org/gems/rails_best_practices), [Source](https://github.com/railsbp/rails_best_practices)
 * Test Coverage
-  * 1.9: [SimpleCov](http://rubygems.org/gems/simplecov) and [SimpleCov-Rcov-Text](http://rubygems.org/gems/simplecov-rcov-text)
+  * 1.9: [SimpleCov](http://rubygems.org/gems/simplecov) and SimpleCov::Formatter::MetricFu
   * 1.8: [Rcov](http://rubygems.org/gems/rcov)
 * Hotspots (a meta-metric of the above)
 
@@ -218,4 +279,3 @@ This is the official repository for metric_fu.  The original repository by Jake
 
 
 [![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/metricfu/metric_fu/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
-