metric_fu 2.1.4.pre5 → 3.0.0

data/.metrics

@@ -1,8 +1,17 @@
 #!/usr/bin/env ruby
 
 # For testing that this file gets loaded
-puts "Metrics config loaded"
+mf_debug "Metrics config loaded"
 # example configuration
 # MetricFu::Configuration.run do |config|
+#   coverage_file = File.expand_path("coverage/rcov/rcov.txt", Dir.pwd)
+#   config.add_metric(:rcov)
+#   config.add_graph(:rcov)
+#   config.configure_metric(:rcov, {:external => coverage_file})
+# end
+# or
+# MetricFu::Configuration.run do |config|
 #   config.metrics -= [ :rcov ]
 # end
+# you may enable running rcov manually with
+# MetricFu.run_rcov

data/Gemfile

@@ -5,5 +5,10 @@ group :development, :test do
   gem "rspec", '>2'
   gem "test-construct", ">= 1.2.0"
   gem "googlecharts"
+  if ENV['COVERAGE']
+    gem 'simplecov'
+    # https://github.com/kina/simplecov-rcov-text
+    gem 'simplecov-rcov-text'
+  end
 end
 gemspec

data/README.md

@@ -19,17 +19,53 @@ See `metric_fu --help` for more options
 It is currently testing on MRI 1.8.7, 1.9.2, and 1.9.3
 
 * The `japgolly-Saikuro` fork and `metric_fu-roodi` fork are a part of an attempt to get metric_fu working in a modern Ruby environment, specifically compatibility with Ruby 1.9 and Bundler.
-* rcov may fail in ruby 1.9
 * rails_best_practices is disabled in ruby 1.8
+* metric_fu no longer runs rcov itself. You may still use rcov metrics as documented below
 
 ## Documentation
 
-TBD
-
 ### Configuration
 
 see the .metrics file
 
+### Using Coverage Metrics
+
+in your .metrics file add the below to run pre-generated metrics
+
+    MetricFu::Configuration.run do |config|
+      coverage_file = File.expand_path("coverage/rcov/rcov.txt", Dir.pwd)
+      config.add_metric(:rcov)
+      config.add_graph(:rcov)
+      config.configure_metric(:rcov, {:external => coverage_file})
+    end
+
+if you want metric_fu to actually run rcov itself (1.8 only), just add
+
+    MetricFu.run_rcov
+
+#### Rcov metrics with Ruby 1.8
+
+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.txt
+
+#### Simplecov metrics with Ruby 1.9
+
+Add to your Gemfile or otherwise install
+
+    gem 'simplecov'
+    # https://github.com/kina/simplecov-rcov-text
+    gem 'simplecov-rcov-text'
+
+Modify your spec_helper as per the SimpleCov docs and run your tests before running metric_fu
+
+    #in your spec_helper
+    require 'simplecov'
+    require 'simplecov-rcov-text'
+    SimpleCov.formatter = SimpleCov::Formatter::RcovTextFormatter
+    SimpleCov.start
+    # SimpleCov.start 'rails'
+
 ### Historical
 
 There is some useful-but-out-of-date documentation about configuring metric_fu at http://metric-fu.rubyforge.org/ and a change log in the the HISTORY file.

data/lib/metric_fu.rb

@@ -42,11 +42,26 @@ module MetricFu
   end
   def self.configure
     MetricFu.lib_require { 'configuration' }
-    Dir.glob(File.join(MetricFu.metrics_dir, '**/init.rb')).each do |file|
+    init_files = Dir.glob(File.join(MetricFu.metrics_dir, '**/init.rb')).reject do |file|
+      if file =~ /rcov/
+        MetricFu.configuration.mf_debug("rcov is not available. See README")
+        true
+      else
+        false
+      end
+    end
+    init_files.each do |file|
       load file
     end
     MetricFu.configuration
   end
+  def self.run_rcov
+    load File.join(MetricFu.metrics_dir, 'rcov/init.rb')
+  end
+  def self.skip_rcov
+    MetricFu.metrics -= [:rcov]
+    MetricFu.graphs  -= [:rcov]
+  end
   class << self
     %w(scratch output _data).each do |dir|
       define_method("#{dir.gsub(/[^A-Za-z0-9]/,'')}_dir") do

data/lib/metric_fu/cli/helper.rb

@@ -4,9 +4,11 @@ require 'metric_fu/cli/parser'
 module MetricFu
   module Cli
     class Helper
+      def initialize
+        @metric_fu = MetricFu::Run.new
+      end
       def run(options={})
-        @metric_fu = MetricFu::Run.new(options)
-        @metric_fu.run
+        @metric_fu.run(options)
         complete
       end
       def version

data/lib/metric_fu/load_files.rb

@@ -23,7 +23,7 @@ Dir.glob(File.join(MetricFu.errors_dir, '**/*.rb')).each do |file|
   require file
 end
 Dir.glob(File.join(MetricFu.metrics_dir, '**/*.rb')).each do |file|
-  require file
+  require(file) unless file =~ /init.rb/
 end
 Dir.glob(File.join(MetricFu.reporting_dir, '**/*.rb')).each do |file|
   require file

data/lib/metric_fu/run.rb

@@ -1,12 +1,12 @@
 MetricFu.configure
 module MetricFu
   class Run
-    def initialize(options={})
+    def initialize
       STDOUT.sync = true
       load_user_configuration
-      disable_metrics(options)
     end
-    def run
+    def run(options={})
+      disable_metrics(options)
       run_reports
       save_reports
       save_graphs

data/lib/metric_fu/version.rb

@@ -1,3 +1,3 @@
 module MetricFu
-  VERSION = "2.1.4.pre5"
+  VERSION = "3.0.0"
 end

data/metric_fu.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.summary     = "A fistful of code metrics, with awesome templates and graphs"
   s.email       = "github@benjaminfleischer.com"
   s.homepage    = "http://github.com/metricfu/metric_fu"
-  s.description = "Code metrics from Flog, Flay, RCov, Saikuro, Churn, Reek, Roodi, Rails' stats task and Rails Best Practices"
+  s.description = "Code metrics from Flog, Flay, Saikuro, Churn, Reek, Roodi, Rails' stats task and Rails Best Practices, and optionally RCov"
   s.authors     = ["Jake Scruggs", "Sean Soper", "Andre Arko", "Petrik de Heus", "Grant McInnes", "Nick Quaranto", "Édouard Brière", "Carl Youngblood", "Richard Huang", "Dan Mayer", "Benjamin Fleischer"]
   s.rubyforge_project = 'metric_fu'
   s.required_ruby_version     = ">= 1.8.7"
@@ -23,10 +23,6 @@ Gem::Specification.new do |s|
 
   {
     "rails_best_practices"  => ["= #{MetricFu::MetricVersion.rails_best_practices}"],
-    "rcov"                  => ["#{MetricFu::MetricVersion.rcov}"],
-    # still using rcov in ruby 1.9 till some errors are fleshed out
-    # "simplecov"             => [">= 0.5.4"],
-    # "simplecov-rcov"        => [">= 0.2.3"],
     "japgolly-Saikuro"      => ["#{MetricFu::MetricVersion.saikuro}"],
     "metric_fu-roodi"       => [">= #{MetricFu::MetricVersion.roodi}"],
     "flay"                  => ["= #{MetricFu::MetricVersion.flay}"],

data/spec/cli/helper_spec.rb

@@ -1,5 +1,6 @@
 require 'spec_helper'
 require 'metric_fu/cli/helper'
+MetricFu.run_rcov
 
 describe MetricFu::Cli::Helper do
 

data/spec/metric_fu/configuration_spec.rb

@@ -7,6 +7,7 @@ describe MetricFu::Configuration do
     @config = MetricFu.configuration
     @config.reset
     MetricFu.configure
+    MetricFu.run_rcov
     @config.stub :create_directories # no need to create directories for the tests
     @config
   end

data/spec/metric_fu/metrics/hotspots/hotspot_analyzer_spec.rb

@@ -284,8 +284,6 @@ __
           :add_coverage_percentage: 1.3
           :read: 1.3
           :[]: 2.70000000000001
-  :average_score: 27.8909176873585
-  :total_score: 195.23642381151
   - :highest_score: 60.0573892206447
     :path: lib/base/metric_analyzer.rb
     :methods:
@@ -307,6 +305,8 @@ __
           :==: 3.1
           :to_s: 1.3
           :[]: 5.40000000000001
+  :average_score: 27.8909176873585
+  :total_score: 195.23642381151
 __
     end
 

data/spec/metric_fu/metrics/rcov/rcov_spec.rb

@@ -3,7 +3,8 @@ require "spec_helper"
 describe MetricFu::Rcov do
 
   before :each do
-    MetricFu::Configuration.run {}
+    MetricFu.configure
+    MetricFu.run_rcov
     File.stub!(:directory?).and_return(true)
     @rcov = MetricFu::Rcov.new('base_dir')
   end

data/spec/spec_helper.rb

@@ -1,3 +1,10 @@
+if ENV['COVERAGE']
+  require 'simplecov'
+  require 'simplecov-rcov-text'
+  SimpleCov.formatter = SimpleCov::Formatter::RcovTextFormatter
+  SimpleCov.start
+end
+
 require 'rspec/autorun'
 require 'date'
 require 'construct'

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: metric_fu
 version: !ruby/object:Gem::Version
-  version: 2.1.4.pre5
-  prerelease: 6
+  version: 3.0.0
+  prerelease: 
 platform: ruby
 authors:
 - Jake Scruggs
@@ -19,7 +19,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-04 00:00:00.000000000 Z
+date: 2013-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails_best_practices
@@ -37,22 +37,6 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.13.2
-- !ruby/object:Gem::Dependency
-  name: rcov
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: japgolly-Saikuro
   requirement: !ruby/object:Gem::Requirement
@@ -315,8 +299,8 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Code metrics from Flog, Flay, RCov, Saikuro, Churn, Reek, Roodi, Rails'
-  stats task and Rails Best Practices
+description: Code metrics from Flog, Flay, Saikuro, Churn, Reek, Roodi, Rails' stats
+  task and Rails Best Practices, and optionally RCov
 email: github@benjaminfleischer.com
 executables:
 - metric_fu