metric_fu 2.1.4.pre4 → 2.1.4.pre5

data/.metrics

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+# For testing that this file gets loaded
+puts "Metrics config loaded"
+# example configuration
+# MetricFu::Configuration.run do |config|
+#   config.metrics -= [ :rcov ]
+# end

data/CONTRIBUTING.md

@@ -0,0 +1,19 @@
+How to contribute:
+
+1. Fork metric_fu on github.
+2. bundle install
+3. Run the tests ('bundle exec rake')
+4. Run metric_fu on itself ('bundle exec metric_fu -r')
+5. Make the changes you want and back them up with tests.
+6. Make sure two important rake tests still run ('bundle exec rake' and 'bundle exec rake metrics:all')
+7. Commit and send me a pull request with details as to what has been changed.
+
+Extra Credit:
+
+1. Make sure your changes work in 1.8.7, Ruby Enterprise Edition, and 1.9.3 (Hint use 'rvm' to help install multiple rubies)
+2. Update the documentation here or the rubyforge web page inside the `'home_page'` folder
+3. Update the History and give yourself credit.
+
+The more of the above steps you do the easier it will be for me to merge in which will greatly increase you chances of getting your changes accepted.
+
+Also see [Quick guide to writing good bug reports](https://github.com/metricfu/metric_fu/wiki/Issues:-Quick-guide-to-writing-good-bug-reports)

data/README.md

@@ -1,6 +1,6 @@
-This is the official repository for metric_fu.  The original repository by Jake Scruggs at [https://github.com/jscruggs/metric_fu](https://github.com/jscruggs/metric_fu) [has been deprecated.](http://jakescruggs.blogspot.com/2012/08/why-i-abandoned-metricfu.html).
+# 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)
 
-__Installation__
+## Installation
 
     gem install metric_fu
 
@@ -8,75 +8,48 @@ If you have trouble installing the gem, try adding metric_fu to your Gemfile. Yo
 
 See documentation on the rubyforge page for how to customize your metrics. Otherwise, all current information is either in this repo or on the wiki.
 
+## Usage
+
 By default, you can run all metrics from the root of an app with the command `metric_fu -r`
 
-You may also wish to use the `metricfu-metrical` fork, which will probably be merged in at some point.
+See `metric_fu --help` for more options
 
-__Compatibility__
+## Compatibility
 
 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
 
-* Until we can upgrade to the latest RubyParser, metric_fu will fail on parsing some 1.9 code, e.g. the new hash syntax, and possibly have issues with encodings
-
-
-_Gem Badge_
-
-[![Gem Version](https://badge.fury.io/rb/metric_fu.png)](http://badge.fury.io/rb/metric_fu)
-
-
-__CI Build Status__
-
-[![Build Status](https://secure.travis-ci.org/metricfu/metric_fu.png)](http://travis-ci.org/metricfu/metric_fu)
+## Documentation
 
-This project runs [travis-ci.org](http://travis-ci.org)
+TBD
 
-__Code Quality__
+### Configuration
 
-[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/metricfu/metric_fu)
+see the .metrics file
 
-This project runs [https://codeclimate.com/](https://codeclimate.com/)
+### Historical
 
-__Gem Dependencies__
+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.
 
-[![Dependency Status](https://gemnasium.com/metricfu/metric_fu.png)](https://gemnasium.com/metricfu/metric_fu)
+## Contributions
 
-This project runs [https://gemnasium.com/metricfu](https://gemnasium.com/metricfu)
+See the TODO for some ideas
 
-===============================================================================
+See CONTRIBUTING for how to contribute
 
-For documentation, in addition to this file and the wiki, 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.
+## Resources:
 
-How to contribute:
-
-1. Fork metric_fu on github.
-2. bundle install
-3. Run the tests ('bundle exec rake')
-4. Run metric_fu on itself ('bundle exec metric_fu -r')
-5. Make the changes you want and back them up with tests.
-6. Make sure two important rake tests still run ('bundle exec rake' and 'bundle exec rake metrics:all')
-7. Commit and send me a pull request with details as to what has been changed.
-
-Extra Credit:
-
-1. Make sure your changes work in 1.8.7, Ruby Enterprise Edition, and 1.9.3 (Hint use 'rvm' to help install multiple rubies)
-2. Update the documentation here or the rubyforge web page inside the `'home_page'` folder
-3. Update the History and give yourself credit.
-
-
-The more of the above steps you do the easier it will be for me to merge in which will greatly increase you chances of getting your changes accepted.
-
-Also see [Quick guide to writing good bug reports](https://github.com/metricfu/metric_fu/wiki/Issues:-Quick-guide-to-writing-good-bug-reports)
-
-Resources:
+This is the official repository for metric_fu.  The original repository by Jake Scruggs at [https://github.com/jscruggs/metric_fu](https://github.com/jscruggs/metric_fu) [has been deprecated.](http://jakescruggs.blogspot.com/2012/08/why-i-abandoned-metricfu.html).
 
 * Github: http://github.com/metricfu/metric_fu
 * Issue Tracker: http://github.com/metricfu/metric_fu/issues
 * Google Group: http://groups.google.com/group/metric_fu
 * Historical Homepage: http://metric-fu.rubyforge.org/
 
-Original Resources:
+### Original Resources:
 
 * Github: http://github.com/jscruggs/metric_fu
 * Issue Tracker: http://github.com/jscruggs/metric_fu/issues

data/bin/metric_fu

@@ -1,134 +1,9 @@
 #!/usr/bin/env ruby
 require 'metric_fu'
-require 'optparse'
+require 'metric_fu/cli/client'
 
-# see https://github.com/grosser/pru/blob/master/bin/pru
-module MetricFu
-  class CLIHelper
-    def initialize
-      @metric_fu = MetricFu::Run.new
-    end
-    def run
-      @metric_fu.run
-      complete
-    end
-    def version
-      MetricFu::VERSION
-    end
-    def shutdown
-      out "\nShuting down. Bye"
-      exit(1)
-    end
-    def banner
-      "MetricFu: A Fistful of code metrics"
-    end
-    def usage
-      <<-EOS
-      #{banner}
-      Use --help for help
-      EOS
-
-    end
-    def executable_name
-      'metric_fu'
-    end
-    private
-    def out(text)
-      STDOUT.puts text
-    end
-    def error(text)
-      STDERR.puts text
-    end
-    def complete
-      out "all done"
-      exit(0)
-    end
-  end
-end
-cli = MetricFu::CLIHelper.new
+cli = MetricFu::Cli::Client.new
 # see http://obtiva.com/blog/185-fun-with-ruby-it-s-a-trap
 trap("INT") { cli.shutdown }
 
-require 'optparse'
-# see https://github.com/florianpilz/CLI-Option-Parser-Examples
-# https://raw.github.com/florianpilz/micro-optparse/master/lib/micro-optparse/parser.rb
-module MicroOptParse
-  class Parser
-    attr_accessor :banner, :version
-    def initialize
-      @options = []
-      @used_short = []
-      @default_values = nil
-      yield self if block_given?
-    end
-
-    def option(name, desc, settings = {})
-      @options << [name, desc, settings]
-    end
-
-    def short_from(name)
-      name.to_s.chars.each do |c|
-        next if @used_short.include?(c) || c == "_"
-        return c # returns from short_from method
-      end
-    end
-
-    def validate(options) # remove this method if you want fewer lines of code and don't need validations
-      options.each_pair do |key, value|
-        opt = @options.find_all{ |o| o[0] == key }.first
-        key = "--" << key.to_s.gsub("_", "-")
-        unless opt[2][:value_in_set].nil? || opt[2][:value_in_set].include?(value)
-          puts "Parameter for #{key} must be in [" << opt[2][:value_in_set].join(", ") << "]" ; exit(1)
-        end
-        unless opt[2][:value_matches].nil? || opt[2][:value_matches] =~ value
-          puts "Parameter for #{key} must match /" << opt[2][:value_matches].source << "/" ; exit(1)
-        end
-        unless opt[2][:value_satisfies].nil? || opt[2][:value_satisfies].call(value)
-          puts "Parameter for #{key} must satisfy given conditions (see description)" ; exit(1)
-        end
-      end
-    end
-
-    def process!(arguments = ARGV)
-      @result = (@default_values || {}).clone # reset or new
-      @optionparser ||= OptionParser.new do |p| # prepare only once
-        @options.each do |o|
-          @used_short << short = o[2][:short] || short_from(o[0])
-          @result[o[0]] = o[2][:default] || false # set default
-          klass = o[2][:default].class == Fixnum ? Integer : o[2][:default].class
-
-          if [TrueClass, FalseClass, NilClass].include?(klass) # boolean switch
-            p.on("-" << short, "--[no-]" << o[0].to_s.gsub("_", "-"), o[1]) {|x| @result[o[0]] = x}
-          else # argument with parameter
-            p.on("-" << short, "--" << o[0].to_s.gsub("_", "-") << " " << o[2][:default].to_s, klass, o[1]) {|x| @result[o[0]] = x}
-          end
-        end
-
-        p.banner = @banner unless @banner.nil?
-        p.on_tail("-h", "--help", "Show this message") {puts p ; exit}
-        short = @used_short.include?("v") ? "-V" : "-v"
-        p.on_tail(short, "--version", "Print version") {puts @version ; exit} unless @version.nil?
-        @default_values = @result.clone # save default values to reset @result in subsequent calls
-      end
-
-      begin
-        @optionparser.parse!(arguments)
-      rescue OptionParser::ParseError => e
-        puts e.message ; exit(1)
-      end
-
-      validate(@result) if self.respond_to?("validate")
-      @result
-    end
-  end
-end
-options = MicroOptParse::Parser.new do |p|
-    p.banner = cli.banner
-    p.version = cli.version
-    p.option :run, "Run all metrics with defaults"
-end.process!
-if options[:run]
-  cli.run
-else
-  STDOUT.puts cli.usage
-end
+cli.run

data/bin/mf-stats

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby_noexec_wrapper
 require 'rubygems'
 begin
-  puts File.exists?('Gemfile') && `bundle && bundle exec rake stats`
+  puts File.exists?('Gemfile') && `bundle check && bundle exec rake stats || rake stats`
 rescue StandardError, LoadError => e
   puts `rake stats`
 end

data/lib/metric_fu/cli/client.rb

@@ -0,0 +1,26 @@
+require 'metric_fu'
+require 'metric_fu/cli/helper'
+require 'metric_fu/cli/parser'
+module MetricFu
+  module Cli
+    class Client
+
+      def initialize
+        @helper = MetricFu::Cli::Helper.new
+      end
+      def shutdown
+        @helper.shutdown
+      end
+      def run
+        options =  @helper.process_options
+        mf_debug "Got options #{options.inspect}"
+        if options[:run]
+          @helper.run(options)
+        else
+          STDOUT.puts @helper.usage
+        end
+      end
+
+    end
+  end
+end

data/lib/metric_fu/cli/helper.rb

@@ -0,0 +1,62 @@
+require 'metric_fu'
+require 'metric_fu/cli/parser'
+# see https://github.com/grosser/pru/blob/master/bin/pru
+module MetricFu
+  module Cli
+    class Helper
+      def run(options={})
+        @metric_fu = MetricFu::Run.new(options)
+        @metric_fu.run
+        complete
+      end
+      def version
+        MetricFu::VERSION
+      end
+      def shutdown
+        out "\nShuting down. Bye"
+        exit(1)
+      end
+      def banner
+        "MetricFu: A Fistful of code metrics"
+      end
+      def usage
+        <<-EOS
+        #{banner}
+        Use --help for help
+        EOS
+      end
+      def executable_name
+        'metric_fu'
+      end
+
+      def metrics
+        MetricFu.configuration.metrics.sort_by(&:to_s)
+      end
+
+      def process_options(argv=ARGV.dup)
+        options = MetricFu::Cli::MicroOptParse::Parser.new do |p|
+            p.banner = self.banner
+            p.version = self.version
+            p.option :run, "Run all metrics with defaults", :default => false
+            metrics.each do |metric|
+              p.option metric.to_sym, "Enables or disables #{metric.to_s.titleize}", :default => true #, :value_in_set => [true, false]
+            end
+            p.option :open, "Open report in browser", :default => true
+        end.process!(argv)
+        options
+      end
+
+      private
+      def out(text)
+        STDOUT.puts text
+      end
+      def error(text)
+        STDERR.puts text
+      end
+      def complete
+        out "all done"
+        exit(0)
+      end
+    end
+  end
+end

data/lib/metric_fu/cli/parser.rb

@@ -0,0 +1,78 @@
+require 'optparse'
+module MetricFu
+  module Cli
+    # see https://github.com/florianpilz/CLI-Option-Parser-Examples
+    # https://raw.github.com/florianpilz/micro-optparse/master/lib/micro-optparse/parser.rb
+    module MicroOptParse
+      class Parser
+        attr_accessor :banner, :version
+        def initialize
+          @options = []
+          @used_short = []
+          @default_values = nil
+          yield self if block_given?
+        end
+
+        def option(name, desc, settings = {})
+          @options << [name, desc, settings]
+        end
+
+        def short_from(name)
+          name.to_s.chars.each do |c|
+            next if @used_short.include?(c) || c == "_"
+            return c # returns from short_from method
+          end
+        end
+
+        def validate(options) # remove this method if you want fewer lines of code and don't need validations
+          options.each_pair do |key, value|
+            opt = @options.find_all{ |o| o[0] == key }.first
+            key = "--" << key.to_s.gsub("_", "-")
+            unless opt[2][:value_in_set].nil? || opt[2][:value_in_set].include?(value)
+              puts "Parameter for #{key} must be in [" << opt[2][:value_in_set].join(", ") << "]" ; exit(1)
+            end
+            unless opt[2][:value_matches].nil? || opt[2][:value_matches] =~ value
+              puts "Parameter for #{key} must match /" << opt[2][:value_matches].source << "/" ; exit(1)
+            end
+            unless opt[2][:value_satisfies].nil? || opt[2][:value_satisfies].call(value)
+              puts "Parameter for #{key} must satisfy given conditions (see description)" ; exit(1)
+            end
+          end
+        end
+
+        def process!(arguments = ARGV)
+          @result = (@default_values || {}).clone # reset or new
+          @optionparser ||= OptionParser.new do |p| # prepare only once
+            @options.each do |o|
+              @used_short << short = o[2][:short] || short_from(o[0])
+              @result[o[0]] = o[2][:default] || false # set default
+              klass = o[2][:default].class == Fixnum ? Integer : o[2][:default].class
+
+              if [TrueClass, FalseClass, NilClass].include?(klass) # boolean switch
+                p.on("-" << short, "--[no-]" << o[0].to_s.gsub("_", "-"), o[1]) {|x| @result[o[0]] = x}
+              else # argument with parameter
+                p.on("-" << short, "--" << o[0].to_s.gsub("_", "-") << " " << o[2][:default].to_s, klass, o[1]) {|x| @result[o[0]] = x}
+              end
+            end
+
+            p.banner = @banner unless @banner.nil?
+            p.on_tail("-h", "--help", "Show this message") {puts p ; exit}
+            short = @used_short.include?("v") ? "-V" : "-v"
+            p.on_tail(short, "--version", "Print version") {puts @version ; exit} unless @version.nil?
+            @default_values = @result.clone # save default values to reset @result in subsequent calls
+          end
+
+          begin
+            @optionparser.parse!(arguments)
+          rescue OptionParser::ParseError => e
+            puts e.message ; exit(1)
+          end
+
+          validate(@result) if self.respond_to?("validate")
+          @result
+        end
+      end
+    end
+
+  end
+end

data/lib/metric_fu/configuration.rb

@@ -1,5 +1,7 @@
 require 'fileutils'
+require 'rbconfig'
 MetricFu.reporting_require { 'templates/awesome/awesome_template' }
+MetricFu.logging_require { 'mf_debugger' }
 module MetricFu
 
 
@@ -49,6 +51,10 @@ module MetricFu
       MfDebugger::Logger.debug_on = toggle
     end
 
+    def mf_debug(msg)
+      MfDebugger.mf_debug msg
+    end
+
     # TODO review if these code is functionally duplicated in the
     # base generator initialize
     def reset
@@ -113,11 +119,13 @@ module MetricFu
     end
 
     def platform #:nodoc:
+      # TODO, change
+      # RbConfig::CONFIG['ruby_install_name'].dup
       return RUBY_PLATFORM
     end
 
     def self.ruby_strangely_makes_accessors_private?
-      !!(RUBY_VERSION =~ /1.9.2/)
+      !!(RUBY_VERSION =~ /1.9.2/) || defined?(JRUBY_VERSION)
     end
     protected unless ruby_strangely_makes_accessors_private?
 

data/lib/metric_fu/metrics/flog/flog.rb

@@ -1,5 +1,6 @@
 require 'pathname'
 require 'optparse'
+require 'rbconfig'
 require 'flog'
 class RubyParser
   alias_method :original_process, :process
@@ -33,7 +34,7 @@ module MetricFu
       @flogger.flog files
 
     rescue LoadError
-      if RUBY_PLATFORM =~ /java/
+      if defined?(JRUBY_VERSION)
         puts 'running in jruby - flog tasks not available'
       end
     end

data/lib/metric_fu/metrics/rcov/init.rb

@@ -1,18 +1,20 @@
 MetricFu::Configuration.run do |config|
   config.add_metric(:rcov)
   config.add_graph(:rcov)
+    rcov_opts = [
+      "--sort coverage",
+      "--no-html",
+      "--text-coverage",
+      "--no-color",
+      "--profile",
+      "--exclude-only '.*'",
+      '--include-file "\Aapp,\Alib"'
+    ]
+    rcov_opts << "-Ispec" if File.exist?("spec")
   config.configure_metric(:rcov,
       { :environment => 'test',
-                    :test_files => ['test/**/*_test.rb',
-                                    'spec/spec_helper.rb', # NOTE: ensure it is loaded before the specs
-                                    'spec/**/*_spec.rb'],
-                    :rcov_opts => ["--sort coverage",
-                                   "--no-html",
-                                   "--text-coverage",
-                                   "--no-color",
-                                   "--profile",
-                                   "--rails",
-                                   "--exclude /gems/,/Library/,/usr/,spec"],
+                    :test_files =>  Dir['{spec,test}/**/*_{spec,test}.rb'],
+                    :rcov_opts => rcov_opts,
                     :external => nil
                   })
 end

data/lib/metric_fu/run.rb

@@ -1,8 +1,10 @@
 MetricFu.configure
 module MetricFu
   class Run
-    def initialize
+    def initialize(options={})
       STDOUT.sync = true
+      load_user_configuration
+      disable_metrics(options)
     end
     def run
       run_reports
@@ -13,8 +15,9 @@ module MetricFu
 
     # ensure :hotspots runs last
     def report_metrics(metrics=MetricFu.metrics)
-      hotspots = metrics.delete(:hotspots)
-      MetricFu.metrics.push(:hotspots)
+      MetricFu.configuration.metrics -= [ :hotspots ]
+      MetricFu.configuration.metrics += [ :hotspots ]
+      MetricFu.configuration.metrics
     end
     def run_reports
       report_metrics.each {|metric|
@@ -50,6 +53,22 @@ module MetricFu
         MetricFu.report.show_in_browser(MetricFu.output_directory)
       end
     end
+    private
+    def load_user_configuration
+      file = File.join(Dir.pwd, '.metrics')
+      load file if File.exist?(file)
+    end
+    def disable_metrics(options)
+      report_metrics.each do |metric|
+        if options[metric.to_sym]
+          mf_debug "using metric #{metric}"
+        else
+          mf_debug "disabling metric #{metric}"
+          MetricFu.configuration.metrics -= [ metric ]
+          MetricFu.configuration.graphs -= [ metric ]
+          mf_debug "active metrics are #{MetricFu.configuration.metrics.inspect}"
+        end
+      end
+    end
   end
 end
-

data/lib/metric_fu/version.rb

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

data/spec/cli/helper_spec.rb

@@ -0,0 +1,146 @@
+require 'spec_helper'
+require 'metric_fu/cli/helper'
+
+describe MetricFu::Cli::Helper do
+
+  describe "defaults" do
+
+    let(:helper)  { MetricFu::Cli::Helper.new }
+    let(:defaults) { helper.process_options }
+
+    context "on every Ruby version" do
+
+      it "opens the report in a browser" do
+        defaults[:open].should be_true
+      end
+
+      it "enables Flog" do
+        defaults[:flog].should be_true
+      end
+
+      it "enables Flay" do
+        defaults[:flay].should be_true
+      end
+
+      it "enables Reek" do
+        defaults[:reek].should be_true
+      end
+
+      it "enables Hotspots" do
+        defaults[:hotspots].should be_true
+      end
+
+      it "enables Churn" do
+        defaults[:churn].should be_true
+      end
+
+      it "enables Saikuro" do
+        defaults[:saikuro].should be_true
+      end
+
+      it "enables RCov" do
+        defaults[:rcov].should be_true
+      end
+
+    end
+
+    context "on Ruby 1.8.7" do
+
+      before { helper.stub(:ruby).and_return("1.8.7") }
+
+      it "disables rails_best_practices" do
+        defaults[:rails_best_practices].should be_false
+      end
+
+    end
+
+    context "on Ruby 1.9" do
+
+      before { helper.stub(:ruby).and_return("1.9.3") }
+
+      xit "enables Rails Best Practices" do
+        defaults[:rails_best_practices].should be_true
+      end
+
+    end
+
+  end
+
+  describe ".parse" do
+    let(:helper)  { MetricFu::Cli::Helper.new }
+
+    it "turns open in browser off" do
+      helper.process_options(["--no-open"])[:open].should be_false
+    end
+
+    it "turns open in browser on" do
+      helper.process_options(["--open"])[:open].should be_true
+    end
+
+    it "turns saikuro off" do
+      helper.process_options(["--no-saikuro"])[:saikuro].should be_false
+    end
+
+    it "turns saikuro on" do
+      helper.process_options(["--saikuro"])[:saikuro].should be_true
+    end
+
+    it "turns churn off" do
+      helper.process_options(["--no-churn"])[:churn].should be_false
+    end
+
+    it "turns churn on" do
+      helper.process_options(["--churn"])[:churn].should be_true
+    end
+
+    it "turns flay off" do
+      helper.process_options(["--no-flay"])[:flay].should be_false
+    end
+
+    it "turns flay on" do
+      helper.process_options(["--flay"])[:flay].should be_true
+    end
+
+    it "turns flog off" do
+      helper.process_options(["--no-flog"])[:flog].should be_false
+    end
+
+    it "turns flog on" do
+      helper.process_options(["--flog"])[:flog].should be_true
+    end
+
+    it "turns hotspots off" do
+      helper.process_options(["--no-hotspots"])[:hotspots].should be_false
+    end
+
+    it "turns hotspots on" do
+      helper.process_options(["--hotspots"])[:hotspots].should be_true
+    end
+
+    it "turns rcov off" do
+      helper.process_options(["--no-rcov"])[:rcov].should be_false
+    end
+
+    it "turns rcov on" do
+      helper.process_options(["--rcov"])[:rcov].should be_true
+    end
+
+    it "turns reek off" do
+      helper.process_options(["--no-reek"])[:reek].should be_false
+    end
+
+    it "turns reek on" do
+      helper.process_options(["--reek"])[:reek].should be_true
+    end
+
+    it "turns roodi off" do
+      helper.process_options(["--no-roodi"])[:roodi].should be_false
+    end
+
+    it "turns roodi on" do
+      helper.process_options(["--roodi"])[:roodi].should be_true
+    end
+
+  end
+
+end

data/spec/metric_fu/configuration_spec.rb

@@ -12,27 +12,27 @@ describe MetricFu::Configuration do
   end
 
   def base_directory
-    @config.instance_variable_get(:@base_directory)
+    @config.send(:base_directory)
   end
 
   def output_directory
-    @config.instance_variable_get(:@output_directory)
+    @config.send(:output_directory)
   end
 
   def scratch_directory
-    @config.instance_variable_get(:@scratch_directory)
+    @config.send(:scratch_directory)
   end
 
   def template_directory
-    @config.instance_variable_get(:@template_directory)
+    @config.send(:template_directory)
   end
 
   def template_class
-    @config.instance_variable_get(:@template_class)
+    @config.send(:template_class)
   end
 
   def metric_fu_root
-    @config.instance_variable_get(:@metric_fu_root_directory)
+    @config.send(:metric_fu_root_directory)
   end
   def load_metric(metric)
     load File.join(MetricFu.metrics_dir, metric, 'init.rb')
@@ -96,58 +96,62 @@ describe MetricFu::Configuration do
 
       it 'should set @flay to {:dirs_to_flay => @code_dirs}' do
         load_metric 'flay'
-        @config.instance_variable_get(:@flay).
+        @config.send(:flay).
                 should == {:dirs_to_flay => ['lib'], :filetypes=>["rb"], :minimum_score => 100}
       end
 
       it 'should set @flog to {:dirs_to_flog => @code_dirs}' do
         load_metric 'flog'
-        @config.instance_variable_get(:@flog).
+        @config.send(:flog).
                 should == {:dirs_to_flog => ['lib']}
       end
 
       it 'should set @reek to {:dirs_to_reek => @code_dirs}' do
         load_metric 'reek'
-        @config.instance_variable_get(:@reek).
+        @config.send(:reek).
                 should == {:config_file_pattern=>nil, :dirs_to_reek => ['lib']}
       end
 
       it 'should set @roodi to {:dirs_to_roodi => @code_dirs}' do
         load_metric 'roodi'
-        @config.instance_variable_get(:@roodi).
+        @config.send(:roodi).
                 should == { :dirs_to_roodi => MetricFu.code_dirs,
                     :roodi_config => "#{MetricFu.root_dir}/config/roodi_config.yml"}
       end
 
       it 'should set @churn to {}' do
         load_metric 'churn'
-        @config.instance_variable_get(:@churn).
+        @config.send(:churn).
                 should == { :start_date => %q("1 year ago"), :minimum_churn_count => 10}
       end
 
 
-      it 'should set @rcov to { :test_files => ["test/**/*_test.rb",
-                                                "spec/**/*_spec.rb"]
-                                :rcov_opts  => ["--sort coverage",
-                                                "--no-html",
-                                                "--text-coverage",
-                                                "--no-color",
-                                                "--profile",
-                                                "--rails",
-                                                "--exclude /gems/,/Library/,/usr/,spec"]}' do
+      it 'should set @rcov to ' +
+                            %q(:test_files =>  Dir['{spec,test}/**/*_{spec,test}.rb'],
+                            :rcov_opts => [
+                              "--sort coverage",
+                              "--no-html",
+                              "--text-coverage",
+                              "--no-color",
+                              "--profile",
+                              "--exclude-only '.*'",
+                              '--include-file "\Aapp,\Alib"',
+                              "-Ispec"
+                            ]) do
         load_metric 'rcov'
-        @config.instance_variable_get(:@rcov).
+        @config.send(:rcov).
                 should ==  { :environment => 'test',
-                             :test_files => ['test/**/*_test.rb',
-                                             'spec/spec_helper.rb',
-                                             'spec/**/*_spec.rb'],
-                             :rcov_opts => ["--sort coverage",
-                                           "--no-html",
-                                           "--text-coverage",
-                                           "--no-color",
-                                           "--profile",
-                                           "--rails",
-                                           "--exclude /gems/,/Library/,/usr/,spec"],
+                            :test_files =>  Dir['{spec,test}/**/*_{spec,test}.rb'],
+                            :rcov_opts => [
+                              "--sort coverage",
+                              "--no-html",
+                              "--text-coverage",
+                              "--no-color",
+                              "--profile",
+                              "--exclude-only '.*'",
+                              '--include-file "\Aapp,\Alib"',
+                              "-Ispec"
+                            ],
                             :external => nil}
       end
 
@@ -159,7 +163,7 @@ describe MetricFu::Configuration do
                                    :error_cyclo => "7",
                                    :formater => "text" }' do
         load_metric 'saikuro'
-        @config.instance_variable_get(:@saikuro).
+        @config.send(:saikuro).
                 should ==  { :output_directory => "#{scratch_directory}/saikuro",
                       :input_directory => ['lib'],
                       :cyclo => "",
@@ -189,27 +193,35 @@ describe MetricFu::Configuration do
       end
 
       describe '#set_graphs ' do
-        it 'should set the graphs to include rails_best_practices' do
-          @config.graphs.should include(:rails_best_practices)
+        if RUBY_VERSION < '1.9'
+          it 'should not set the graphs to include rails_best_practices for ruby 1.8' do
+            @config.graphs.should_not include(:rails_best_practices)
+          end
+        else
+          it 'should set the graphs to include rails_best_practices' do
+            @config.graphs.should include(:rails_best_practices)
+          end
         end
       end
 
       describe '#set_code_dirs ' do
         it 'should set the @code_dirs instance var to ["app", "lib"]' do
-          @config.instance_variable_get(:@code_dirs).
+          @config.send(:code_dirs).
                   should == ['app','lib']
         end
       end
       it 'should set @stats to {}' do
         load_metric 'stats'
-        @config.instance_variable_get(:@stats).
+        @config.send(:stats).
                 should == {}
       end
 
-      it 'should set @rails_best_practices to {}' do
-        load_metric 'rails_best_practices'
-        @config.instance_variable_get(:@rails_best_practices).
-                should == {}
+      unless RUBY_VERSION < '1.9'
+        it 'should set @rails_best_practices to {}' do
+          load_metric 'rails_best_practices'
+          @config.send(:rails_best_practices).
+                  should == {}
+        end
       end
     end
 
@@ -227,7 +239,7 @@ describe MetricFu::Configuration do
       end
 
       it 'should set the @code_dirs instance var to ["lib"]' do
-        @config.instance_variable_get(:@code_dirs).should == ['lib']
+        @config.send(:code_dirs).should == ['lib']
       end
     end
   end
@@ -238,11 +250,15 @@ describe MetricFu::Configuration do
 
     [:churn, :flog, :flay, :reek, :roodi, :rcov, :hotspots, :saikuro].each do |metric|
       it "should have a reader for #{metric}" do
-        @config.respond_to?(metric).should be_true
+        expect {
+          @config.send(metric.to_sym)
+        }.to_not raise_error
       end
 
       it "should have a writer for #{metric}=" do
-        @config.respond_to?((metric.to_s + '=').to_sym).should be_true
+        expect {
+          @config.send((metric.to_s + '=').to_sym, '')
+        }.to_not raise_error
       end
     end
   end

data/spec/metric_fu/metrics/flay/flay_spec.rb

@@ -3,7 +3,10 @@ require "spec_helper"
 describe Flay do
   describe "emit method" do
     it "should look at the dirs" do
-      MetricFu::Configuration.run {|config| config.flay = { :dirs_to_flay => ['app', 'lib'], :filetypes => ['rb']  } }
+      MetricFu::Configuration.run {|config|
+        config.add_metric(:flay)
+        config.configure_metric(:flay, { :dirs_to_flay => ['app', 'lib'], :filetypes => ['rb']  })
+      }
       File.stub!(:directory?).and_return(true)
       @flay = MetricFu::Flay.new('base_dir')
 
@@ -12,7 +15,10 @@ describe Flay do
     end
 
     it "should limit flay scores by the minimum_score" do
-      MetricFu::Configuration.run {|config| config.flay = { :dirs_to_flay => [], :minimum_score => 99 } }
+      MetricFu::Configuration.run {|config|
+        config.add_metric(:flay)
+        config.configure_metric(:flay, { :dirs_to_flay => [], :minimum_score => 99 })
+      }
       File.stub!(:directory?).and_return(true)
       @flay = MetricFu::Flay.new('base_dir')
 

data/spec/metric_fu/metrics/reek/reek_spec.rb

@@ -4,7 +4,8 @@ describe Reek do
   describe "emit" do
     it "should include config parameters" do
       MetricFu::Configuration.run do |config|
-        config.reek = {:config_file_pattern => 'lib/config/*.reek', :dirs_to_reek => []}
+        config.add_metric(:reek)
+        config.configure_metric(:reek,{:config_file_pattern => 'lib/config/*.reek', :dirs_to_reek => []})
       end
       reek = MetricFu::Reek.new
       reek.should_receive(:`).with(/--config lib\/config\/\*\.reek/).and_return("")

data/spec/metric_fu/metrics/roodi/roodi_spec.rb

@@ -4,7 +4,8 @@ describe Roodi do
   describe "emit" do
     it "should add config options when present" do
       MetricFu::Configuration.run do |config|
-        config.roodi = {:roodi_config => 'lib/config/roodi_config.yml', :dirs_to_roodi => []}
+        config.add_metric(:roodi)
+        config.configure_metric(:roodi,{:roodi_config => 'lib/config/roodi_config.yml', :dirs_to_roodi => []})
       end
       roodi = MetricFu::Roodi.new
       roodi.should_receive(:`).with(/-config=lib\/config\/roodi_config\.yml/).and_return("")
@@ -13,7 +14,8 @@ describe Roodi do
 
     it "should NOT add config options when NOT present" do
       MetricFu::Configuration.run do |config|
-        config.roodi = {:dirs_to_roodi => []}
+        config.add_metric(:roodi)
+        config.configure_metric(:roodi,{:dirs_to_roodi => []})
       end
       roodi = MetricFu::Roodi.new
       roodi.stub(:`)
@@ -21,4 +23,4 @@ describe Roodi do
       roodi.emit
     end
   end
-end
+end

data/spec/run_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+require 'metric_fu/cli/helper'
+
+describe MetricFu, "running" do
+
+  let(:helper)  { MetricFu::Cli::Helper.new }
+
+  before do
+    FileUtils.rm_rf("tmp/metric_fu")
+  end
+
+  it "all these tests should not rely on shelling out to the command line" do
+    pending("shelling to bundler is very slow")
+  end
+
+  xit "has a clean start" do
+    File.should_not exist("tmp/metric_fu")
+  end
+
+  xit "loads the .metrics file" do
+    out = metric_fu
+    out.should include "Metrics config loaded"
+  end
+
+  xit "creates a report yaml file" do
+    expect { metric_fu }.to create_file("tmp/metric_fu/report.yml")
+  end
+
+  xit "creates a report html file" do
+    expect { metric_fu }.to create_file("tmp/metric_fu/output/index.html")
+  end
+
+  xit "displays help" do
+    out = metric_fu("bundle exec metric_fu --help")
+    out.should include helper.banner
+  end
+
+  xit "displays version" do
+    out = metric_fu("bundle exec metric_fu --version")
+    out.should == "#{MetricFu::VERSION}"
+  end
+
+  xit "errors on unknown flags" do
+    expect { metric_fu "--asdasdasda" }.to raise_error
+  end
+
+  def metric_fu(command = "--no-open")
+    results = `metric_fu #{command} 2>&1`
+    $?.to_i.should eq(0), "The command 'metric_fu #{command}' failed!\n\n#{results}"
+    results.strip
+  end
+
+end

data/spec/support/matcher_create_file.rb

@@ -0,0 +1,30 @@
+RSpec::Matchers.define :create_file do |expected|
+
+  match do |block|
+    @before = File.exist?(expected)
+    block.call
+    @after = File.exist?(expected)
+    !@before && @after
+  end
+
+  failure_message_for_should do |block|
+    existed_before_message expected do
+      "The file #{expected.inspect} was not created"
+    end
+  end
+
+  failure_message_for_should_not do |block|
+    existed_before_message expected do
+      "The file #{expected.inspect} was created"
+    end
+  end
+
+  def existed_before_message(expected)
+    if @before
+      "The file #{expected.inspect} existed before, so this test doesn't work"
+    else
+      yield
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metric_fu
 version: !ruby/object:Gem::Version
-  version: 2.1.4.pre4
+  version: 2.1.4.pre5
   prerelease: 6
 platform: ruby
 authors:
@@ -19,7 +19,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-03 00:00:00.000000000 Z
+date: 2013-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails_best_practices
@@ -330,8 +330,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .metrics
 - .rspec
 - .travis.yml
+- CONTRIBUTING.md
 - Gemfile
 - HISTORY.md
 - MIT-LICENSE
@@ -365,6 +367,9 @@ files:
 - home_page/title.gif
 - home_page/title_back.gif
 - lib/metric_fu.rb
+- lib/metric_fu/cli/client.rb
+- lib/metric_fu/cli/helper.rb
+- lib/metric_fu/cli/parser.rb
 - lib/metric_fu/configuration.rb
 - lib/metric_fu/data_structures/careful_array.rb
 - lib/metric_fu/data_structures/line_numbers.rb
@@ -462,6 +467,7 @@ files:
 - lib/metric_fu/version.rb
 - lib/metric_fu_requires.rb
 - metric_fu.gemspec
+- spec/cli/helper_spec.rb
 - spec/metric_fu/configuration_spec.rb
 - spec/metric_fu/data_structures/line_numbers_spec.rb
 - spec/metric_fu/data_structures/location_spec.rb
@@ -501,7 +507,9 @@ files:
 - spec/resources/saikuro_sfiles/thing.rb_cyclo.html
 - spec/resources/yml/20090630.yml
 - spec/resources/yml/metric_missing.yml
+- spec/run_spec.rb
 - spec/spec_helper.rb
+- spec/support/matcher_create_file.rb
 - spec/support/suite.rb
 homepage: http://github.com/metricfu/metric_fu
 licenses:
@@ -524,11 +532,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: metric_fu
-rubygems_version: 1.8.25
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A fistful of code metrics, with awesome templates and graphs
 test_files:
+- spec/cli/helper_spec.rb
 - spec/metric_fu/configuration_spec.rb
 - spec/metric_fu/data_structures/line_numbers_spec.rb
 - spec/metric_fu/data_structures/location_spec.rb
@@ -568,5 +577,7 @@ test_files:
 - spec/resources/saikuro_sfiles/thing.rb_cyclo.html
 - spec/resources/yml/20090630.yml
 - spec/resources/yml/metric_missing.yml
+- spec/run_spec.rb
 - spec/spec_helper.rb
+- spec/support/matcher_create_file.rb
 - spec/support/suite.rb