metric_fu 2.1.3.7.19 → 2.1.4.pre

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--profile

data/.travis.yml

@@ -3,3 +3,15 @@ rvm:
   - 1.9.3
   - 1.9.2
   - 1.8.7
+  - 1.8.6
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-18mode
+  - rbx-19mode
+matrix:
+  allow_failures:
+    - rvm: 1.8.6
+    - rvm: jruby-18mode
+    - rvm: jruby-19mode
+    - rvm: rbx-18mode
+    - rvm: rbx-19mode

data/Gemfile

@@ -1,8 +1,8 @@
 source :rubygems
 
-gem 'rake', '<0.9.3'
+gem 'rake'
 group :development, :test do
-  gem "rspec", "= 1.3.0"
+  gem "rspec", '>2'
   gem "test-construct", ">= 1.2.0"
   gem "googlecharts"
 end

data/HISTORY.md

@@ -1,6 +1,20 @@
-=== MetricFu 2.1.3.7 / 2013-01-08
+=== master ===
+
+* Add commandline behavior to `metric_fu`. Now there are options -v, -r, and -h
+* Clean up global ivars a bit in Configuration
+* Re-organized test files - Michael Stark
+* Rspec2 - Michael Stark
+* Unify verbose logging
+* Modularize
+
+=== MetricFu 2.1.3.7.18.1 / 2013-01-09
+
+* Same as 2.1.3.7.18.1 but gem packaged using ruby 1.8 dependencies, including ripper
+
+=== MetricFu 2.1.3.7.19 / 2013-01-08
 
 * Bug fix, ensure Configuration is loaded before Run, https://github.com/metricfu/metric_fu/issues/36
+* Gem packaged using ruby 1.9 dependencies.  Learned that we cannot dynamically change dependencies for a packaged gem.
 
 === MetricFu 2.1.3.6 / 2013-01-02
 
@@ -10,7 +24,6 @@
 * Remove executable metric_fu dependency on rake
 * TODO: some unclear dependency issues may make metrics in 1.9 crash, esp Flog, Flay, Stats
 
-
 === MetricFu 2.1.3.5 / 2013-01-01
 
 * Issue #35, Namespace MetricFu::Table. -Benjamin Fleischer

data/README.md

@@ -3,22 +3,27 @@ This is the official repository for metric_fu.  The original repository by Jake
 __Installation__
 
     gem install metric_fu
-    
-See documentation on the rubyforge page for how to customize your metrics.
 
-By default, you can run all metrics from the root of an app with the command `metric_fu`
+If you have trouble installing the gem, try adding metric_fu to your Gemfile. You may also want to file a ticket on the issues page.
+
+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.
+
+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.
 
 __Compatibility__
 
-It is currently testing on MRI 1.8.7 and 1.9.3
+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.
 
 * 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
 
-* Please note that rake version 10.0.2 cannot be used, whereas 0.8.7 and 0.9.2 do work.
+
+_Gem Badge_
+
+[![Gem Version](https://badge.fury.io/rb/metric_fu.png)](http://badge.fury.io/rb/metric_fu)
 
 
 __CI Build Status__
@@ -41,36 +46,38 @@ This project runs [https://gemnasium.com/metricfu](https://gemnasium.com/metricf
 
 ===============================================================================
 
-See http://metric-fu.rubyforge.org/ for documentation, or the HISTORY file for a change log.
+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.
 
 How to contribute:
 
 1. Fork metric_fu on github.
 2. bundle install
-3. Run the tests ('rake')
-4. Run metric_fu on itself ('rake metrics:all')
+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 ('rake' and 'rake metrics:all')
+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 (web page inside the 'home_page' folder)
+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:
 
 * 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
-* Homepage: http://metric-fu.rubyforge.org/
+* Historical Homepage: http://metric-fu.rubyforge.org/
 
 Original Resources:
 
 * Github: http://github.com/jscruggs/metric_fu
 * Issue Tracker: http://github.com/jscruggs/metric_fu/issues
-* My Blog: http://jakescruggs.blogspot.com/
+* Jake's Blog: http://jakescruggs.blogspot.com/

data/TODO.md

@@ -1,29 +1,131 @@
 # TODO list
 
+* Keep HISTORY.md in master up to date
+
+## Before next release
+
+* Move code that references rcov out of
+
+    lib/metrics/hotspots/hotspot_analyzer.rb
+    lib/reporting/graphs/engines/bluff.rb
+    lib/reporting/graphs/engines/gchart.rb
+    lib/reporting/templates/awesome/css/default.css
+    lib/reporting/templates/awesome/index.html.erb
+    lib/reporting/templates/standard/default.css
+    lib/reporting/templates/standard/index.html.erb
+
+* Move code that references flog out of
+
+    lib/configuration.rb
+    lib/metrics/hotspots/analysis/code_issue.rb
+    lib/metrics/hotspots/analysis/scoring_strategies.rb
+    lib/metrics/hotspots/hotspot_analyzer.rb
+    lib/reporting/graphs/engines/bluff.rb
+    lib/reporting/graphs/engines/gchart.rb
+    lib/reporting/templates/awesome/index.html.erb
+    lib/reporting/templates/standard/index.html.erb
+
+* Move code that references flay out of
+
+    lib/metrics/generator.rb
+    lib/metrics/hotspots/analysis/code_issue.rb
+    lib/metrics/hotspots/hotspot_analyzer.rb
+    lib/reporting/graphs/engines/bluff.rb
+    lib/reporting/graphs/engines/gchart.rb
+    lib/reporting/templates/awesome/index.html.erb
+    lib/reporting/templates/standard/index.html.erb
+
+* Move code that references churn out of
+
+    lib/metrics/hotspots/analysis/code_issue.rb
+    lib/metrics/hotspots/hotspot_analyzer.rb
+    lib/metrics/hotspots/init.rb
+    lib/reporting/templates/awesome/index.html.erb
+    lib/reporting/templates/standard/index.html.erb
+
+* Move code that references rails_best_practices out of
+
+    lib/metrics/hotspots/analysis/code_issue.rb
+    lib/metrics/hotspots/hotspot_analyzer.rb
+    lib/reporting/graphs/engines/bluff.rb
+    lib/reporting/graphs/engines/gchart.rb
+    lib/reporting/templates/awesome/index.html.erb
+    lib/reporting/templates/standard/index.html.erb
+
+
+* Move code that references reek out of
+
+    lib/data_structures/location.rb
+    lib/metrics/hotspots/analysis/code_issue.rb
+    lib/metrics/hotspots/analysis/scoring_strategies.rb
+    lib/metrics/hotspots/hotspot_analyzer.rb
+    lib/reporting/graphs/engines/bluff.rb
+    lib/reporting/graphs/engines/gchart.rb
+    lib/reporting/templates/awesome/index.html.erb
+    lib/reporting/templates/standard/index.html.erb
+
+
+* Move code that references roodi out of
+
+    lib/metrics/hotspots/analysis/code_issue.rb
+    lib/metrics/hotspots/hotspot_analyzer.rb
+    lib/reporting/graphs/engines/bluff.rb
+    lib/reporting/graphs/engines/gchart.rb
+    lib/reporting/templates/awesome/index.html.erb
+    lib/reporting/templates/standard/index.html.erb
+
+* Move code that references saikuro out of
+
+    lib/metrics/hotspots/analysis/code_issue.rb
+    lib/metrics/hotspots/hotspot_analyzer.rb
+    lib/reporting/templates/awesome/index.html.erb
+    lib/reporting/templates/standard/index.html.erb
+
+* Move code that references stats out of
+
+lib/reporting/graphs/engines/bluff.rb
+lib/reporting/graphs/engines/gchart.rb
+lib/reporting/templates/awesome/index.html.erb
+lib/reporting/templates/standard/index.html.erb
+
+* Review how metric_fu uses each tools to generate metrics, e.g. by shelling out commands, rake task, modifying the output, etc.
+
+* Change MetricFu.report.add(metric) to e.g. MetricFu.generate_report(metric) to make clear that this actually runs the tool
+
+* Allow the coverage task to specify the command it runs plus any flags (see bundler/capistrano options)
+
+* Test against a rails app
 
 ## Features
 
-* Look into removing rcov and churn, and adding
+* Remove rcov by default
+* Either allow user to define a command to run a coverage task or supply a directory with coverage results.   We can't predict every test setup to run coverage correctly, but we can analyze results.
+* Look into getting everything to run on RubyParser ~> 3
+* Look into adding
   * https://github.com/metricfu/code_statistics
   * brakeman https://github.com/metricfu/brakeman
   * cane https://github.com/square/cane
   * laser https://github.com/metricfu/laser
 * Add configurable logger to all output streams
+* Allow command-line metric_fu to accept parameters, and especially output its version
 * Color code flog results with scale from: http://jakescruggs.blogspot.com/2008/08/whats-good-flog-score.html
 * Make running metric_fu on metric_fu less embarrassing
 * Load all gems at config time so you fail fast if one is missing
+* Refactor the hotspots code
+
 
 ## Testing
 
 * Determine how to test metric_fu against codebases that are not metric_fu, to ensure it works on most applications
-* Re-organize test files structure to align with changed structure of library files
+  * This is especially true for rails applications
+* <strike>Re-organize test files structure to align with changed structure of library files</strike>
 * Remove / Modify Devver code from the generators/hotspots_spec and base/hotspot_analzyer_spec
-* Don't leave around test artifacts such as the folders './foo' and './is set'
+* <strike>Don't leave around test artifacts such as the folders './foo' and './is set'</strike>
 
 ## Bugs / Fixes
 
 * Fix occasional gem install metric_fu failures such as with ripper in Ruby 1.9
-* Fork roodi and correct the yaml
+* <strike>Fork roodi and correct the yaml</strike>
 * See https://github.com/metricfu/metric_fu/issues/2 about updating gems
 
 ## Ruby 1.9 compatibility
@@ -34,10 +136,22 @@
 ## Misc
 
 * Determine if CodeIssue is used, else remove it
-* Update the homepage http://metric-fu.rubyforge.org/
+* Remove references to Ruport from the Devver / Caliper code
+* Update or move the homepage http://metric-fu.rubyforge.org/
+* Is there any reason not to remove the Manifest.txt?
+* See other documentation code for examples to improve ours:
+  * https://github.com/charliesome/better_errors/blob/master/CONTRIBUTING.md
+  * https://github.com/charliesome/better_errors/blob/master/README.md
 * Other intersting libraries to consider:
+  * https://gist.github.com/4562865 for generating Flog on ERB templates by jamesmartin
+  * https://github.com/chad/turbulence churn and complexity (flog)
   * https://github.com/vinibaggio/discover-unused-partials
-  * https://github.com/metricfu/heckle
+  * https://github.com/metricfu/heckle (test mutation)
+  * https://github.com/mbj/mutant (test mutation)
   * https://github.com/metricfu/gauntlet
-  * https://github.com/metricfu/repodepot-ruby
+  * https://github.com/metricfu/repodepot-ruby https://twitter.com/jakescruggs/status/70521977303076865
   * https://github.com/eladmeidar/rails_indexes
+  * https://github.com/trptcolin/consistency_fail 
+  * https://github.com/thoughtbot/appraisal
+  * https://github.com/jenkinsci/rubymetrics-plugin
+  * https://github.com/holman/hopper

data/bin/metric_fu

@@ -1,2 +1,134 @@
-require File.expand_path(File.join(File.dirname(__FILE__),'..','lib','metric_fu'))
-MetricFu::Run.new.run
+#!/usr/bin/env ruby
+require 'metric_fu'
+require 'optparse'
+
+# 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
+# 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

data/lib/metric_fu.rb

@@ -1,6 +1,6 @@
 module MetricFu
   APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__),'..'))
-  LIB_ROOT = File.join(APP_ROOT,'lib')
+  LIB_ROOT = File.join(APP_ROOT,'lib/metric_fu')
   @loaded_files = []
   class << self
     attr_reader :loaded_files
@@ -40,6 +40,13 @@ module MetricFu
   def self.artifact_dir
     (ENV['CC_BUILD_ARTIFACTS'] || 'tmp/metric_fu')
   end
+  def self.configure
+    MetricFu.lib_require { 'configuration' }
+    Dir.glob(File.join(MetricFu.metrics_dir, '**/init.rb')).each do |file|
+      load file
+    end
+    MetricFu.configuration
+  end
   class << self
     %w(scratch output _data).each do |dir|
       define_method("#{dir.gsub(/[^A-Za-z0-9]/,'')}_dir") do