metric_fu 4.2.1 → 4.3.0

data/lib/metric_fu/reporting/graphs/grapher.rb

@@ -1,11 +1,18 @@
 module MetricFu
   class Grapher
-    def initialize
+    attr_accessor :output_directory
+
+    def initialize(opts = {})
       self.class.require_graphing_gem
+      self.output_directory = opts[:output_directory]
+    end
+
+    def output_directory
+      @output_directory || MetricFu.output_directory
     end
 
     def self.require_graphing_gem
       # to be overridden by charting engines
     end
   end
-end
+end

data/lib/metric_fu/reporting/result.rb

@@ -0,0 +1,51 @@
+module MetricFu
+
+  # MetricFu.result memoizes access to a Result object, that will be
+  # used throughout the lifecycle of the MetricFu app.
+  def self.result
+    @result ||= Result.new
+  end
+
+  # = Result
+  #
+  # The Result class is responsible for one thing:
+  #
+  # It tracks the results generated by each metric used in this test run.
+  class Result
+
+    # Renders the result of the result_hash into a yaml serialization
+    # ready for writing out to a file.
+    #
+    # @return YAML
+    #   A YAML object containing the results of the result generation
+    #   process
+    def as_yaml
+      result_hash.to_yaml
+    end
+
+    def per_file_data
+      @per_file_data ||= {}
+    end
+
+    def result_hash #:nodoc:
+      @result_hash ||= {}
+    end
+
+    # Adds a hash from a passed result, produced by one of the Generator
+    # classes to the aggregate result_hash managed by this hash.
+    #
+    # @param result_type Hash
+    #   The hash to add to the aggregate result_hash
+    def add(result_type)
+      mf_debug "result requested #{result_type}"
+      clazz = MetricFu.const_get(result_type.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase })
+      mf_debug "result class found #{clazz}"
+      metric_options = MetricFu.send(result_type)
+      inst = clazz.new(metric_options)
+
+      result_hash.merge!(inst.generate_result)
+
+      inst.per_file_info(per_file_data) if inst.respond_to?(:per_file_info)
+    end
+  end
+end

data/lib/metric_fu/reporting/templates/awesome/awesome_template.rb

@@ -11,22 +11,22 @@ class AwesomeTemplate < MetricFu::Template
 
     # Copy Bluff javascripts to output directory
     Dir[File.join(template_directory, '..', 'javascripts', '*')].each do |f|
-      FileUtils.copy(f, File.join(MetricFu.output_directory, File.basename(f)))
+      FileUtils.cp(f, File.join(self.output_directory, File.basename(f)))
     end
 
     @metrics = {}
-    report.each_pair do |section, contents|
+    result.each_pair do |section, contents|
       if template_exists?(section)
         create_instance_var(section, contents)
         @metrics[section] = contents
         create_instance_var(:per_file_data, per_file_data)
-        mf_debug  "Generating html for section #{section} with #{template(section)} for report #{report.class}"
+        mf_debug  "Generating html for section #{section} with #{template(section)} for result #{result.class}"
         @html = erbify(section)
         html = erbify('layout')
         fn = output_filename(section)
-        MetricFu.report.save_output(html, MetricFu.output_directory, fn)
+        formatter.write_template(html, fn)
       else
-        mf_debug  "no template for section #{section} with #{template(section)} for report #{report.class}"
+        mf_debug  "no template for section #{section} with #{template(section)} for result #{result.class}"
       end
     end
 
@@ -35,9 +35,9 @@ class AwesomeTemplate < MetricFu::Template
       @html = erbify('index')
       html = erbify('layout')
       fn = output_filename('index')
-      MetricFu.report.save_output(html, MetricFu.output_directory, fn)
+      formatter.write_template(html, fn)
     else
-      mf_debug  "no template for section index for report #{report.class}"
+      mf_debug  "no template for section index for result #{result.class}"
     end
 
     write_file_data
@@ -101,7 +101,7 @@ class AwesomeTemplate < MetricFu::Template
       end
       out << "<table></body></html>"
 
-      MetricFu.report.save_output(out, MetricFu.output_directory, fn)
+      formatter.write_template(out, fn)
     end
   end
   def template_directory

data/lib/metric_fu/run.rb

@@ -6,61 +6,38 @@ module MetricFu
       load_user_configuration
     end
     def run(options={})
-      disable_metrics(options)
-      run_reports
-      save_reports
-      save_graphs
-      display_results
+      configure_run(options)
+      measure
+      display_results if options[:open]
     end
 
     # ensure :hotspots runs last
     def report_metrics(metrics=MetricFu.metrics)
-      MetricFu.configuration.metrics -= [ :hotspots ]
-      MetricFu.configuration.metrics += [ :hotspots ]
+      MetricFu.configuration.metrics.sort_by! {|x| x == :hotspots ? 1 : 0 }
       MetricFu.configuration.metrics
     end
-    def run_reports
+    def measure
+      reporter.start
       report_metrics.each {|metric|
-        mf_log "** STARTING METRIC #{metric}"
-        MetricFu.report.add(metric)
-        mf_log "** ENDING METRIC #{metric}"
-      }
-    end
-    def save_reports
-      mf_log "** SAVING REPORTS"
-      mf_debug "** SAVING REPORT YAML OUTPUT TO #{MetricFu.base_directory}"
-      MetricFu.report.save_output(MetricFu.report.as_yaml,
-                                  MetricFu.base_directory,
-                                  "report.yml")
-      mf_debug "** SAVING REPORT DATA OUTPUT TO #{MetricFu.data_directory}"
-      MetricFu.report.save_output(MetricFu.report.as_yaml,
-                                  MetricFu.data_directory,
-                                  "#{Time.now.strftime("%Y%m%d")}.yml")
-      mf_debug "** SAVING TEMPLATIZED REPORT"
-      MetricFu.report.save_templatized_report
-    end
-    def save_graphs
-      mf_log "** GENERATING GRAPHS"
-      mf_debug "** PREPARING TO GRAPH"
-      MetricFu.graphs.each {|graph|
-        mf_debug "** Graphing #{graph} with #{MetricFu.graph_engine}"
-        MetricFu.graph.add(graph, MetricFu.graph_engine)
+        reporter.start_metric(metric)
+        MetricFu.result.add(metric)
+        reporter.finish_metric(metric)
       }
-      mf_debug "** GENERATING GRAPH"
-      MetricFu.graph.generate
+      reporter.finish
     end
     def display_results
-      if MetricFu.report.open_in_browser?
-        mf_debug "** OPENING IN BROWSER FROM #{MetricFu.output_directory}"
-        MetricFu.report.show_in_browser(MetricFu.output_directory)
-      end
-      mf_log "** COMPLETE"
+      reporter.display_results
     end
     private
     def load_user_configuration
       file = File.join(Dir.pwd, '.metrics')
       load file if File.exist?(file)
     end
+    # Updates configuration based on runtime options.
+    def configure_run(options)
+      disable_metrics(options)
+      configure_formatters(options)
+    end
     def disable_metrics(options)
       return if options.size == 0
       report_metrics.each do |metric|
@@ -74,5 +51,23 @@ module MetricFu
         end
       end
     end
+    def configure_formatters(options)
+      # Configure from command line if any.
+      if options[:format]
+        MetricFu.formatters.clear # Command-line format takes precedence.
+        Array(options[:format]).each do |format, o|
+          MetricFu.configuration.add_formatter(format, o)
+        end
+      end
+      # If no formatters specified, use defaults.
+      if MetricFu.configuration.formatters.empty?
+        Array(MetricFu::Formatter::DEFAULT).each do |format, o|
+          MetricFu.configuration.add_formatter(format, o)
+        end
+      end
+    end
+    def reporter
+      Reporter.new(MetricFu.configuration.formatters)
+    end
   end
 end

data/lib/metric_fu/version.rb

@@ -1,3 +1,3 @@
 module MetricFu
-  VERSION = "4.2.1"
+  VERSION = "4.3.0"
 end

data/lib/metric_fu_requires.rb

@@ -1,46 +1,63 @@
+# Used to find which version, if any, of a gem to use when running command-line tools
 module MetricFu
   module MetricVersion
     extend self
-    def reek
-      ['= 1.3.1']
-    end
-    def flog
-      ['= 3.2.2']
-    end
-    def flay
-      ['= 2.0.1']
-    end
-    def churn
-      ['= 0.0.28']
-    end
-    def roodi
-      ['>= 2.2.1']
-    end
-    def rails_best_practices
-      ['= 1.13.2']
-    end
 
-    def ruby2ruby
-      ['~> 2.0', '>= 2.0.2']
-    end
-    def ruby_parser
-      ['~> 3.0', '>= 3.1.1']
+    # @return [Array] rcov version if running rcov
+    # Rcov is not a dependency in the gemspec
+    # but is available to be shelled out
+    def rcov
+      ['~> 0.8']
     end
-    def sexp_processor
-      ['~> 4.0']
+
+    # @example MetricFu::MetricVersion.flog will return the gem version of Flog to require
+    # @return [nil] when the metric_fu gem dependency isn't specified
+    # @return [Array] represenation of the metric_fu gem dependency if specified
+    #   in the gemspec.
+    # Will raise method missing if :version_for is falsy
+    # @see gems
+    def method_missing(method,*args,&block)
+      if (gem_version = version_for(method.to_s))
+        gem_version != [] ? gem_version : nil
+      else
+        super
+      end
     end
-    def parallel
-      ['= 0.6.2']
+
+    private
+
+    # Generates and returns an abstract syntax tree from the gemspec
+    # @return [Sexp]
+    def ast
+      require 'ruby_parser'
+      parser = RubyParser.new
+      parser.parse(gemspec)
     end
 
-    def rcov
-      ['~> 0.8']
+
+    # Uses the ast to find all the specified runtime dependencies and their version requirements
+    # @return Array<Array<gem_name,gem_version>>, where gem_name is a string and gem_version is an Array
+    def gems
+      @gems ||= ast.find{|node| node[0] == :iter}.
+        find{|node| node[0] == :block}.                     # in the specification block
+        select{|node| node[0] == :call }.                   # select all the methods
+        select{|node| node[2] == :add_runtime_dependency }. # that are :add_runtime_dependency
+        map{|node| [                                        # return a mapped array of
+          node[3][1].downcase.sub('metric_fu-',''),         # the downcased gem name (with any metric_fu- prefix removed)
+          Array(Array(node[4])[1..-1]).map{|node|node[1]}   #  and an Array of the specified gem version(s)
+        ]}
     end
-    def saikuro
-      ['>= 1.1.1.0']
+
+    # @return Array<String> where the strings are valid gem version requires
+    #   The Array is empty if no gem version is specified
+    def version_for(gem_name)
+      node = gems.find{|node|node[0] == gem_name.downcase}  # find the gem in the ast with the given downcased name
+      node && node[1]                                       # if found, return its version specification
     end
-    def cane
-      ['= 2.5.2']
+
+    # Read in the contents of the gemspec
+    def gemspec
+      File.read(File.expand_path('../../metric_fu.gemspec', __FILE__))
     end
   end
 end

data/metric_fu.gemspec

@@ -25,45 +25,36 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files = ["HISTORY.md", "CONTRIBUTING.md", "TODO.md", "MIT-LICENSE"]
   s.rdoc_options = ["--main", "README.md"]
 
-  {
-    # metric dependencies
-    "flay"                  => MetricFu::MetricVersion.flay,
-    "churn"                 => MetricFu::MetricVersion.churn,
-    "flog"                  => MetricFu::MetricVersion.flog,
-    "reek"                  => MetricFu::MetricVersion.reek,
-    "cane"                  => MetricFu::MetricVersion.cane,
-      # specifying gem dependencies for
-      # flay, churn, flog, reek, and cane
-      "ruby_parser"           => MetricFu::MetricVersion.ruby_parser,
-      "sexp_processor"        => MetricFu::MetricVersion.sexp_processor,
-      # reek
-      "ruby2ruby"             => MetricFu::MetricVersion.ruby2ruby,
-      # cane
-      "parallel"              => MetricFu::MetricVersion.parallel,
+  # metric dependencies
+  s.add_runtime_dependency 'flay',                  ['= 2.0.1']
+  s.add_runtime_dependency 'churn',                 ['= 0.0.28']
+  s.add_runtime_dependency 'flog',                  ['= 3.2.2']
+  s.add_runtime_dependency 'reek',                  ['= 1.3.1']
+  s.add_runtime_dependency 'cane',                  ['= 2.5.2']
+    # specifying gem dependencies for
+    # flay, churn, flog, reek, and cane
+    s.add_runtime_dependency 'ruby_parser',         ['~> 3.0', '>= 3.1.1']
+    s.add_runtime_dependency 'sexp_processor',      ['~> 4.0']
+      # reek only
+      s.add_runtime_dependency 'ruby2ruby',         ['~> 2.0', '>= 2.0.2']
+      # cane only
+      s.add_runtime_dependency 'parallel',          ['= 0.6.2']
       # required by main, a churn dependency
-      "fattr"                 => ["= 2.2.1"],
-      "arrayfields"           => ["= 4.7.4"],
-      "map"                   => ["= 6.2.0"],
-    "rails_best_practices"  => MetricFu::MetricVersion.rails_best_practices,
-    "japgolly-Saikuro"      => MetricFu::MetricVersion.saikuro,
-    "metric_fu-roodi"       => MetricFu::MetricVersion.roodi,
-    #
-    # other dependencies
-    # ruby version identification
-    'redcard'               => [],
-    # syntax highlighting
-    "coderay"               => [],
-    # default graphing libraries
-    "bluff"                 => [],
-    # to_json support
-    'multi_json'            => [],
-  }.each do |gem, version|
-    if version == []
-      s.add_runtime_dependency(gem)
-    else
-      s.add_runtime_dependency(gem,version)
-    end
-  end
+      s.add_runtime_dependency 'fattr',             ["= 2.2.1"]
+      s.add_runtime_dependency 'arrayfields',       ["= 4.7.4"]
+      s.add_runtime_dependency 'map',               ["= 6.2.0"]
+  s.add_runtime_dependency 'rails_best_practices',  ['= 1.13.2']
+  s.add_runtime_dependency 'metric_fu-Saikuro',     ['>= 1.1.1.0']
+  s.add_runtime_dependency 'metric_fu-roodi',       ['>= 2.2.1']
 
-end
+  # other dependencies
+  # ruby version identification
+  s.add_runtime_dependency 'redcard'
+  # syntax highlighting
+  s.add_runtime_dependency 'coderay'
+  # default graphing libraries
+  s.add_runtime_dependency 'bluff'
+  # to_json support
+  s.add_runtime_dependency 'multi_json'
 
+end

data/spec/cli/helper_spec.rb

@@ -49,6 +49,9 @@ describe MetricFu::Cli::Helper do
         defaults[:rcov].should be_true
       end
 
+      it "runs by default" do
+        defaults[:run].should be_true
+      end
     end
 
     if MetricFu.configuration.mri?
@@ -163,6 +166,18 @@ describe MetricFu::Cli::Helper do
       helper.process_options(["--roodi"])[:roodi].should be_true
     end
 
+    context 'given a single format' do
+      it "sets the format" do
+        helper.process_options(["--format", "json"])[:format].should eq([['json']])
+      end
+    end
+
+    context 'given multiple formats' do
+      it "sets multiple formats" do
+        helper.process_options(["--format", "json", "--format", "yaml"])[:format].should eq([['json'], ['yaml']])
+      end
+    end
+
   end
 
 end

data/spec/metric_fu/configuration_spec.rb

@@ -194,7 +194,7 @@ describe MetricFu::Configuration do
 
       before(:each) do
         @config = MetricFu.configuration
-        @config.stub!(:rails?).and_return(true)
+        @config.stub(:rails?).and_return(true)
         @config.reset
         MetricFu.configure
         %w(stats rails_best_practices).each do |metric|
@@ -236,7 +236,7 @@ describe MetricFu::Configuration do
     describe 'if #rails? is false ' do
       before(:each) do
         get_new_config
-        @config.stub!(:rails?).and_return(false)
+        @config.stub(:rails?).and_return(false)
         %w(stats rails_best_practices).each do |metric|
           load_metric metric
         end
@@ -329,4 +329,42 @@ describe MetricFu::Configuration do
       end
     end
   end
+
+  describe '#add_formatter' do
+    before(:each) { get_new_config }
+
+    context 'given a built-in formatter' do
+      before do
+        @config.add_formatter('html')
+      end
+
+      it 'adds to the list of formatters' do
+        @config.formatters.first.should be_an_instance_of(MetricFu::Formatter::HTML)
+      end
+    end
+
+    context 'given a custom formatter by class name' do
+      before do
+        stub_const('MyCustomFormatter', Class.new() { def initialize(*); end })
+        @config.add_formatter('MyCustomFormatter')
+      end
+
+      it 'adds to the list of formatters' do
+        @config.formatters.first.should be_an_instance_of(MyCustomFormatter)
+      end
+    end
+
+    context 'given multiple formatters' do
+      before do
+        stub_const('MyCustomFormatter', Class.new() { def initialize(*); end })
+        @config.add_formatter('html')
+        @config.add_formatter('yaml')
+        @config.add_formatter('MyCustomFormatter')
+      end
+
+      it 'adds each to the list of formatters' do
+        @config.formatters.count.should eq(3)
+      end
+    end
+  end
 end