metric_fu 4.2.1 → 4.3.0

data/.metrics

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
 
 # For testing that this file gets loaded
-mf_debug "Metrics config loaded"
+$metric_file_loaded = true
+
 # example configuration
 # MetricFu::Configuration.run do |config|
 #   coverage_file = File.expand_path("coverage/rcov/rcov.txt", Dir.pwd)
@@ -16,3 +17,20 @@ mf_debug "Metrics config loaded"
 # end
 # you may enable running rcov manually with
 # MetricFu.run_rcov
+#
+# 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 ...
+# MetricFu::Configuration.run do |config|
+#   config.add_formatter(:html)
+#   config.add_formatter(:yaml, "customreport.yml")
+#   config.add_formatter(MyCustomFormatter)
+# end
+#
+# metric_fu 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:
+# require './lib/my_custom_formatter.rb'

data/.travis.yml

@@ -1,8 +1,8 @@
 language: ruby
 bundler_args: --without development
 script: bundle exec rspec
-# gemfile:
-#   - gemfiles/Gemfile.ci
+gemfile:
+  - gemfiles/Gemfile.travis
 # before_install: some_command
 # env:
 #   - "rack=1.3.4"

data/Gemfile

@@ -14,5 +14,6 @@ group :test do
     # https://github.com/kina/simplecov-rcov-text
     gem 'simplecov-rcov-text'
   end
+  gem "fakefs", :require => "fakefs/safe"
 end
-gemspec
+gemspec :path => File.expand_path('..', __FILE__)

data/HISTORY.md

@@ -1,5 +1,29 @@
+Changes are below categorized as `Features, Fixes, or Misc`.
+
+Each change should fall into categories that would affect whether the release is major (breaking changes), minor (new behavior), or patch (bug fix). See [semver](http://semver.org/) and [pessimistic versioning](http://docs.rubygems.org/read/chapter/16#page74)
+
+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
 
+### MetricFu 4.3.0 / 2013-07-26
+
+* Features
+  * Allow customization of reporting results using formatters (Robin Curry #94)
+* Fixes
+  * obey --no-open option (Chris Mason)
+  * Don't run the hotspots metric if it has been disabled (Chris Mason)
+  * No longer crashes when rake stats outputs blank lines (Benjamin Fleischer #103, #24)
+  * Run saikuro metrics the same way as the other metrics (Martin Gotink #100)
+  * Add missing Cane Google Chart Grapher (Benjamin Fleischer)
+  * Fix wrong arguments to display_location, split off line numbers from paths (Benjamin Fleischer #88)
+  * Remove line numbers from direct file link so the browser can open it (Benjamin Fleischer #82)
+  * Make the run specs work without the need to shell out (Robin Curry)
+* Misc
+  * metric_fu runs with the -r option by default (Chris Mason #69)
+  * Switch to metric_fu-Saikuro gem (Benjamin Fleischer)
+  * Reduce Grapher code duplication (Benjamin Fleischer #89)
+
 ### MetricFu 4.2.1 / 2013-05-23
 
 * Fixes

data/README.md

@@ -1,4 +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)
+# 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) [Rdoc](http://rdoc.info/github/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)
 
 ## Metrics
 
@@ -47,6 +49,63 @@ See `metric_fu --help` for more options
 
 * Cane code quality threshold checking is not included in the hotspots report
 
+## 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
+using a relative path:
+
+	metric_fu --out custom_directory  	# outputs to tmp/metric_fu/custom_directory
+
+or a full path:
+
+	metric_fu --out /home/metrics	  	# outputs to /home/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.
+
+
+	metric_fu --format yaml --out custom_report.yml
+or
+
+	metric_fu --format MyCustomFormatter
+
+### Custom Formatters
+
+You 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:
+
+```ruby
+ 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.
+ end
+```
+
+See [lib/metric_fu/formatter/](lib/metric_fu/formatter/) for examples.
+
+metric_fu 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:
+
+```ruby
+require './lib/my_custom_formatter.rb'
+```
+
 ### Configuration
 
 see the .metrics file

data/TODO.md

@@ -84,6 +84,7 @@ instance variables and accessors
   * CLI [Flog](https://github.com/seattlerb/flog/blob/master/lib/flog_cli.rb) Plugins [Flog](https://github.com/seattlerb/flog/blob/master/lib/flog_cli.rb#L34)
 * Look into adding
   * https://github.com/metricfu/code_statistics [1](https://github.com/cloudability/code_statistics)
+    * or extract from rails into a gem [rake task](https://github.com/rails/rails/blob/master/railties/lib/rails/tasks/statistics.rake) [can be modified by rspec](https://github.com/rspec/rspec-rails/blob/master/lib/rspec/rails/tasks/rspec.rake#L38) with the [calculator](https://github.com/rails/rails/blob/master/railties/lib/rails/code_statistics_calculator.rb) and [class](https://github.com/rails/rails/blob/master/railties/lib/rails/code_statistics.rb)
   * brakeman https://github.com/metricfu/brakeman
   * laser https://github.com/metricfu/laser
 * Other intersting libraries to consider:

data/bin/mf-saikuro

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby_noexec_wrapper
+require 'rubygems'
+
+require 'metric_fu_requires'
+
+version = MetricFu::MetricVersion.saikuro
+gem 'metric_fu-Saikuro', version
+load Gem.bin_path('metric_fu-Saikuro', 'saikuro', version)

data/checksum/metric_fu-4.3.0.gem.sha512

@@ -0,0 +1 @@
+7a5e74c8b010bd9629e9cbdcf297cc1d75295338bb34a327a9ed57a742c5fc57107608bd148e31e5355263dc113841249be8719877a68fcb42271212edd71f13

data/gemfiles/Gemfile.travis

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+#to use, from the app root run
+# export BUNDLE_GEMFILE=$PWD/gemfiles/Gemfile.travis
+# when done, unset BUNDLE_GEMFILE
+# for 1.9.2 support because of https://github.com/railsbp/rails_best_practices/blob/master/rails_best_practices.gemspec
+gem 'activesupport', '~> 3.2'
+
+eval_gemfile File.expand_path('../../Gemfile', __FILE__)

data/lib/metric_fu.rb

@@ -25,7 +25,7 @@ module MetricFu
     LIB_ROOT
   end
   class << self
-    %w(metrics reporting logging errors data_structures tasks).each do |dir|
+    %w(metrics formatter reporting logging errors data_structures tasks).each do |dir|
       define_method("#{dir}_dir") do
         File.join(lib_dir,dir)
       end

data/lib/metric_fu/cli/client.rb

@@ -11,8 +11,8 @@ module MetricFu
       def shutdown
         @helper.shutdown
       end
-      def run
-        options =  @helper.process_options
+      def run(argv=ARGV.dup)
+        options =  @helper.process_options(argv)
         mf_debug "Got options #{options.inspect}"
         if options[:run]
           @helper.run(options)

data/lib/metric_fu/cli/helper.rb

@@ -35,15 +35,15 @@ module MetricFu
         MetricFu.configuration.metrics.sort_by(&:to_s)
       end
 
-      def process_options(argv=ARGV.dup)
+      def process_options(argv=[])
         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
+            p.option :run, "Run all metrics with defaults", :default => true
             metrics.each do |metric|
               p.option metric.to_sym, "Enables or disables #{metric.to_s}", :default => true #, :value_in_set => [true, false]
             end
-            p.option :open, "Open report in browser", :default => true
+            p.option :open, "Open report in browser (if supported by formatter)", :default => true
         end.process!(argv)
         options
       end

data/lib/metric_fu/cli/parser.rb

@@ -24,22 +24,6 @@ module MetricFu
           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
@@ -55,6 +39,28 @@ module MetricFu
               end
             end
 
+            p.on("--format FORMAT",
+                 "Specify the formatter to use for output.",
+                 "This option can be specified multiple times.",
+                 "Specify a built-in formatter from the list below,",
+                 "or the fully-qualified class name of your own custom formatter.",
+                 *format_descriptions) do |f|
+              @result[:format] ||= []
+              @result[:format] << [f]
+            end
+
+            p.on("--out FILE|DIR",
+                "Specify the file or directory to use for output",
+                "This option applies to the previously",
+                "specified --format, or the default format",
+                "if no format is specified. Paths are relative to",
+                "#{Pathname.pwd.join(MetricFu.base_directory)}",
+                "Check the specific formatter\'s docs to see",
+                "whether to pass a file or a dir.") do |o|
+              @result[:format] ||= MetricFu::Formatter::DEFAULT
+              @result[:format].last << o
+            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"
@@ -71,6 +77,21 @@ module MetricFu
           validate(@result) if self.respond_to?("validate")
           @result
         end
+
+        # Build a nicely formatted list of built-in
+        # formatter keys and their descriptions
+        # @see MetricFu::Formatter::BUILTIN_FORMATS
+        # @example
+        #    format_descriptions #=> ["  yaml :  Generates the raw output as yaml"]
+        # @return [Array<String>] in the form of
+        #    "   <key>  : <description>."
+        def format_descriptions
+          formats = MetricFu::Formatter::BUILTIN_FORMATS
+          max = formats.keys.map{|s| s.length}.max
+          formats.keys.sort.map do |key|
+            "  #{key}#{' ' * (max - key.length)} : #{formats[key][1]}"
+          end
+        end
       end
     end
 

data/lib/metric_fu/configuration.rb

@@ -61,6 +61,7 @@ module MetricFu
       set_directories
       configure_template
       add_promiscuous_instance_variable(:metrics, [])
+      add_promiscuous_instance_variable(:formatters, [])
       add_promiscuous_instance_variable(:graphs, [])
       add_promiscuous_instance_variable(:graph_engines, [])
       add_promiscuous_method(:graph_engine)
@@ -90,6 +91,10 @@ module MetricFu
       self.graphs = (graphs << metric).uniq
     end
 
+    def add_formatter(format, output = nil)
+      @formatters << MetricFu::Formatter.class_for(format).new(output: output)
+    end
+
     # e.g. :reek, {}
     def configure_metric(metric, metric_configuration)
       add_promiscuous_instance_variable(metric, metric_configuration)
@@ -126,6 +131,10 @@ module MetricFu
       @mri ||= !!RedCard.check(:ruby)
     end
 
+    def rubinius?
+      @rubinius ||= !!RedCard.check(:rubinius)
+    end
+
     def platform #:nodoc:
       # TODO, change
       # RbConfig::CONFIG['ruby_install_name'].dup
@@ -208,6 +217,5 @@ module MetricFu
         add_promiscuous_instance_variable(:code_dirs,['lib'])
       end
     end
-
   end
 end

data/lib/metric_fu/constantize.rb

@@ -0,0 +1,57 @@
+module MetricFu
+  module Constantize
+    # Copied from ActiveSupport and modified so as not to introduce a dependency.
+    # https://github.com/rails/rails/blob/master/activesupport/lib/active_support/inflector/methods.rb#L220
+    def constantize(camel_cased_word)
+      tries ||= 2
+      names = camel_cased_word.split('::')
+      names.shift if names.empty? || names.first.empty?
+
+      names.inject(Object) do |constant, name|
+        if constant == Object
+          constant.const_get(name)
+        else
+          candidate = constant.const_get(name)
+          next candidate if constant.const_defined?(name, false)
+          next candidate unless Object.const_defined?(name)
+
+          # Go down the ancestors to check it it's owned
+          # directly before we reach Object or the end of ancestors.
+          constant = constant.ancestors.inject do |const, ancestor|
+            break const    if ancestor == Object
+            break ancestor if ancestor.const_defined?(name, false)
+            const
+          end
+
+          # owner is in Object, so raise
+          constant.const_get(name, false)
+        end
+      end
+    rescue NameError
+      # May need to attempt to require the file and try again.
+      begin
+        require underscore(camel_cased_word)
+      rescue LoadError => e
+        mf_log e.message
+      end
+
+      if (tries -= 1).zero?
+        raise
+      else
+        retry
+      end
+    end
+
+    # Copied from active_support
+    # https://github.com/rails/rails/blob/51cd6bb829c418c5fbf75de1dfbb177233b1b154/activesupport/lib/active_support/inflector/methods.rb#L88
+    def underscore(camel_cased_word)
+      word = camel_cased_word.to_s.dup
+      word.gsub!(/::/, '/')
+      word.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
+      word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+      word.tr!("-", "_")
+      word.downcase!
+      word
+    end
+  end
+end

data/lib/metric_fu/data_structures/line_numbers.rb

@@ -1,7 +1,13 @@
+# MetricFu::LineNumber
+# (see #initialize)
 require 'ruby_parser'
 module MetricFu
   class LineNumbers
 
+    # Parses ruby code to collect line numbers for class, module, and method definitions.
+    # Used by metrics that don't provide line numbers for class, module, or methods problems
+    # @param contents [String] a string of ruby code
+    # @param file_path [String] the file path for the contents, defaults to empty string
     def initialize(contents,file_path='')
       if contents.to_s.size.zero?
         mf_log "NON PARSEABLE INPUT: File is empty at path #{file_path.inspect}\n\t#{caller.join("\n\t")}"
@@ -27,12 +33,20 @@ module MetricFu
       @locations
     end
 
+    # @param line_number [String]
+    # @return [Boolean] if the given line number is in a method
     def in_method? line_number
       !!@locations.detect do |method_name, line_number_range|
         line_number_range.include?(line_number)
       end
     end
 
+    # @param line_number [Integer]
+    # @return [String, nil] the method which includes that line number, if any
+    # For all collected locations, find the first location where the line_number_range
+    #   includes the line_number
+    #   If a location is found, return its first element
+    #   Else return nil
     def method_at_line line_number
       found_method_and_range = @locations.detect do |method_name, line_number_range|
         line_number_range.include?(line_number)
@@ -44,6 +58,8 @@ module MetricFu
       end
     end
 
+    # @param method [String] the method name being queried
+    # @erturn [Integer, nil] the line number at which the given method is defined
     def start_line_for_method(method)
       return nil unless @locations.has_key?(method)
       @locations[method].first
@@ -53,9 +69,9 @@ module MetricFu
 
     def process_module(sexp)
       module_name = sexp[1]
-      sexp.each_of_type(:class) do |sexp|
-        process_class(sexp, module_name)
-        hide_methods_from_next_round(sexp)
+      sexp.each_of_type(:class) do |exp|
+        process_class(exp, module_name)
+        hide_methods_from_next_round(exp)
       end
       process_class(sexp)
     end