metric_fu 4.4.4 → 4.5.1

data/lib/metric_fu/metrics/stats/template_awesome/stats.html.erb

@@ -1,12 +1,8 @@
 <h3>Lines of Code/Tests Metric Results</h3>
 
 <% graph_name = 'stats' %>
-<% if MetricFu.configuration.graph_engine == :gchart %>
-<img src="<%= graph_name %>.png?<%= Time.now.to_i %>" />
-<% else %>
 <canvas id="graph"></canvas>
 <script language="javascript" src="<%= graph_name %>.js?<%= Time.now.to_i %>" type="text/javascript"></script>
-<% end %>
 
 
 <p>Lines of Code/Tests Metrics Results</p>

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

@@ -1,9 +1,35 @@
+# Class opened and modified by requiring a graph engine
+require 'multi_json'
 module MetricFu
   class Grapher
+
+    @graphers = []
+    # @return all subclassed graphers [Array<MetricFu::Grapher>]
+    def self.graphers
+      @graphers
+    end
+
+    def self.inherited(subclass)
+      @graphers << subclass
+    end
+
+    def self.get_grapher(metric)
+      graphers.find{|grapher|grapher.metric.to_s == metric.to_s}
+    end
+
+    BLUFF_GRAPH_SIZE = "1000x600"
+    BLUFF_DEFAULT_OPTIONS = <<-EOS
+      var g = new Bluff.Line('graph', "#{BLUFF_GRAPH_SIZE}");
+      g.theme_37signals();
+      g.tooltips = true;
+      g.title_font_size = "24px"
+      g.legend_font_size = "12px"
+      g.marker_font_size = "10px"
+    EOS
+
     attr_accessor :output_directory
 
     def initialize(opts = {})
-      self.class.require_graphing_gem
       self.output_directory = opts[:output_directory]
     end
 
@@ -11,8 +37,48 @@ module MetricFu
       @output_directory || MetricFu::Io::FileSystem.directory('output_directory')
     end
 
-    def self.require_graphing_gem
-      # to be overridden by charting engines
+    def get_metrics(metrics, sortable_prefix)
+      not_implemented
+    end
+
+    def graph!
+      title = send(:title)
+      data = send(:data)
+      labels = MultiJson.dump(@labels)
+      output_filename = send(:output_filename)
+      content = <<-EOS
+        #{BLUFF_DEFAULT_OPTIONS}
+        g.title = '#{title}';
+        #{build_data(data)}
+        g.labels = #{labels};
+        g.draw();
+      EOS
+      File.open(File.join(self.output_directory, output_filename), 'w') {|f| f << content }
+    end
+
+    def title
+      not_implemented
+    end
+
+    def date
+      not_implemented
     end
+
+    def output_filename
+      not_implemented
+    end
+
+    private
+
+    def build_data(data)
+      Array(data).map do |label, datum|
+        "g.data('#{label}', [#{datum}]);"
+      end.join("\n")
+    end
+
+    def not_implemented
+      raise "#{__LINE__} in #{__FILE__} from #{caller[0]}"
+    end
+
   end
 end

data/lib/metric_fu/reporting/result.rb

@@ -24,7 +24,11 @@ module MetricFu
     end
 
     def per_file_data
-      @per_file_data ||= {}
+      @per_file_data ||= Hash.new do |hash, filename|
+        hash[filename] = Hash.new do |h, line|
+          h[line] = Array.new
+        end
+      end
     end
 
     def result_hash #:nodoc:

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

@@ -1,3 +1,4 @@
+require 'fileutils'
 require 'coderay'
 MetricFu.metrics_require { 'base_template' }
 MetricFu.lib_require { 'utility' }
@@ -6,8 +7,8 @@ class AwesomeTemplate < MetricFu::Template
 
   def write
     # Getting rid of the crap before and after the project name from integrity
-    # @name = File.basename(Dir.pwd).gsub(/^\w+-|-\w+$/, "")
-    @name = Pathname.new(Dir.pwd).basename
+    # @name = File.basename(MetricFu.run_dir).gsub(/^\w+-|-\w+$/, "")
+    @name = Pathname.new(MetricFu.run_dir).basename
 
     # Copy Bluff javascripts to output directory
     Dir[File.join(template_directory, '..', 'javascripts', '*')].each do |f|
@@ -66,7 +67,10 @@ class AwesomeTemplate < MetricFu::Template
   def write_file_data
 
     per_file_data.each_pair do |file, lines|
-      data = File.open(file, 'r').readlines
+      next if file.to_s.empty?
+      next unless File.file?(file)
+
+      data = File.readlines(file)
       fn = "#{file.gsub(%r{/}, '_')}.html"
 
       out = <<-HTML

data/lib/metric_fu/run.rb

@@ -3,7 +3,6 @@ module MetricFu
   class Run
     def initialize
       STDOUT.sync = true
-      load_user_configuration
     end
     def run(options={})
       configure_run(options)
@@ -27,11 +26,6 @@ module MetricFu
       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)
@@ -39,8 +33,10 @@ module MetricFu
     def disable_metrics(options)
       return if options.size == 0
       report_metrics.each do |metric|
-        if options[metric.to_sym]
+        metric = metric.to_sym
+        if (metric_options = options[metric] )
           mf_debug "using metric #{metric}"
+          configure_metric(metric, metric_options) if metric_options.is_a?(Hash)
         else
           mf_debug "disabling metric #{metric}"
           MetricFu::Metric.get_metric(metric).enabled = false
@@ -48,6 +44,16 @@ module MetricFu
         end
       end
     end
+    def configure_metric(metric, metric_options)
+      MetricFu::Configuration.run do |config|
+        config.configure_metric(metric) do |metric|
+          metric_options.each do |option, value|
+            mf_log "Setting #{metric} option #{option} to #{value}"
+            metric.public_send("#{option}=", value)
+          end
+        end
+      end
+    end
     def configure_formatters(options)
       # Configure from command line if any.
       if options[:format]

data/lib/metric_fu/tasks/metric_fu.rake

@@ -1,7 +1,54 @@
 require 'rake'
+require 'metric_fu/run'
 namespace :metrics do
-  desc "Generate all metrics reports"
-  task :all do
-    MetricFu::Run.new.run
+  def options_tip(task_name)
+    "with options, for example:  rake metrics:#{task_name}['cane: {abc_max: 81}']"
+  end
+  desc "Generate all metrics reports, or #{options_tip('all')}"
+  task :all, [:options] do |t,args|
+    MetricFu.run(process_options(args.options))
+  end
+
+  desc "Run only specified ;-separated metrics, for example, metrics:only[cane;flog] or #{options_tip('only')}"
+  task :only, [:metrics, :options] do |t,args|
+    requested_metrics = args.metrics.to_s.split(';').map(&:strip)
+    enabled_metrics = MetricFu::Metric.enabled_metrics.map(&:name)
+    metrics_to_run = enabled_metrics.select{|metric| requested_metrics.include?(metric.to_s) }
+    MetricFu.run_only(metrics_to_run, process_options(args.options))
+  end
+
+  MetricFu::Metric.enabled_metrics.each do |metric|
+    name = metric.name
+    desc "Generate report for #{name}, or #{options_tip('cane')}"
+    task name, [:options] do |t,args|
+      MetricFu.run_only(name, process_options(args.options))
+    end
+  end
+
+  private
+
+  # from https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/hash/keys.rb
+  class Hash
+    # Destructively, recursively convert all keys to symbols, as long as they respond
+    # to +to_sym+.
+    def recursively_symbolize_keys!
+      keys.each do |key|
+        value = delete(key)
+        new_key = key.intern #rescue
+        self[new_key] = (value.is_a?(Hash) ? value.dup.recursively_symbolize_keys! : value)
+      end
+      self
+    end
+  end
+
+  def process_options(options)
+    return {} if options.nil? or options.empty?
+    options = YAML.load(options)
+    if options.is_a?(Hash)
+      p "Got options #{options.recursively_symbolize_keys!.inspect}"
+      options
+    else
+      raise "Invalid options #{options.inspect}, is a #{options.class}, should be a Hash"
+    end
   end
 end

data/lib/metric_fu/utility.rb

@@ -1,3 +1,5 @@
+require 'yaml'
+require 'fileutils'
 module MetricFu
   module Utility
     module_function
@@ -23,5 +25,13 @@ module MetricFu
       FileUtils.mkdir_p(*args)
     end
 
+    def glob(*args)
+      Dir.glob(*args)
+    end
+
+    def load_yaml(file)
+      YAML.load_file(file)
+    end
+
   end
 end

data/lib/metric_fu/version.rb

@@ -1,3 +1,3 @@
 module MetricFu
-  VERSION = "4.4.4"
+  VERSION = '4.5.1'
 end

data/metric_fu.gemspec

@@ -8,7 +8,12 @@ Gem::Specification.new do |s|
   s.summary     = "A fistful of code metrics, with awesome templates and graphs"
   s.description = "Code metrics from Flog, Flay, Saikuro, Churn, Reek, Roodi, Code Statistics, and Rails Best Practices. (and optionally RCov)"
   s.email       = "github@benjaminfleischer.com"
-  s.authors     = File.readlines('AUTHORS').map(&:strip)
+  author_file   = File.expand_path('AUTHORS', File.dirname(__FILE__))
+  s.authors     = File.readlines(author_file).map(&:strip)
+
+  # used with gem i metric_fu -P HighSecurity
+  s.cert_chain  = ['certs/bf4.pem']
+  s.signing_key = File.expand_path("~/.ssh/gem-private_key.pem") if $0 =~ /gem\z/
 
   s.rubyforge_project           = 'metric_fu'
   s.license                     = 'MIT'
@@ -31,7 +36,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'flay',                  ['>= 2.0.1',  '~> 2.1']
   s.add_runtime_dependency 'churn',                 ['~> 0.0.28']
   s.add_runtime_dependency 'flog',                  ['>= 4.1.1',  '~> 4.1']
-  s.add_runtime_dependency 'reek',                  ['>= 1.3.3',  '~> 1.3']
+  s.add_runtime_dependency 'reek',                  ['>= 1.3.4',  '~> 1.3']
   s.add_runtime_dependency 'cane',                  ['>= 2.5.2',  '~> 2.5']
   s.add_runtime_dependency 'rails_best_practices',  ['>= 1.14.3', '~> 1.14']
   s.add_runtime_dependency 'metric_fu-Saikuro',     ['>= 1.1.1.0']
@@ -43,8 +48,6 @@ Gem::Specification.new do |s|
   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'
 

data/spec/dummy/.gitignore

@@ -0,0 +1 @@
+tmp

data/spec/dummy/.metrics

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+# For testing that this file gets loaded
+$metric_file_loaded = true

data/spec/{resources/yml → fixtures}/20090630.yml

@@ -2957,7 +2957,7 @@
     - :was_run: false
       :content: "       # Getting rid of the crap before and after the project name from integrity"
     - :was_run: false
-      :content: "       @name = File.basename(Dir.pwd).gsub(/^\\w+-|-\\w+$/, \"\")"
+      :content: "       @name = File.basename(MetricFu.run_dir).gsub(/^\\w+-|-\\w+$/, \"\")"
     - :was_run: false
       :content: "   "
     - :was_run: false

data/spec/metric_fu/configuration_spec.rb

@@ -146,7 +146,7 @@ describe MetricFu::Configuration do
       it 'should set @reek to {:dirs_to_reek => @code_dirs}' do
         load_metric 'reek'
         expect(MetricFu::Metric.get_metric(:reek).run_options).to eq(
-                {:config_file_pattern=>nil, :dirs_to_reek => ['lib']}
+                {:config_file_pattern=>'config/*.reek', :dirs_to_reek => ['lib']}
         )
       end
 

data/spec/metric_fu/data_structures/line_numbers_spec.rb

@@ -1,58 +1,60 @@
 require "spec_helper"
 
 describe MetricFu::LineNumbers do
-
+  FIXTURE_DATA = ->(paths) {
+    FIXTURE.load_file( ['line_numbers'].concat(Array(paths)) )
+  }
   describe "in_method?" do
     it "should know if a line is NOT in a method" do
-      ln = MetricFu::LineNumbers.new(File.read("#{resources_path}/line_numbers/foo.rb"))
+      ln = MetricFu::LineNumbers.new(FIXTURE_DATA["foo.rb"])
       ln.in_method?(2).should == false
     end
 
     it "should know if a line is in an instance method" do
-      ln = MetricFu::LineNumbers.new(File.read("#{resources_path}/line_numbers/foo.rb"))
+      ln = MetricFu::LineNumbers.new(FIXTURE_DATA["foo.rb"])
       ln.in_method?(8).should == true
     end
 
     it "should know if a line is in an class method" do
-      ln = MetricFu::LineNumbers.new(File.read("#{resources_path}/line_numbers/foo.rb"))
+      ln = MetricFu::LineNumbers.new(FIXTURE_DATA["foo.rb"])
       ln.in_method?(3).should == true
     end
   end
 
   describe "method_at_line" do
     it "should know the name of an instance method at a particular line" do
-      ln = MetricFu::LineNumbers.new(File.read("#{resources_path}/line_numbers/foo.rb"))
+      ln = MetricFu::LineNumbers.new(FIXTURE_DATA["foo.rb"])
       ln.method_at_line(8).should == "Foo#what"
     end
 
     it "should know the name of a class method at a particular line" do
-      ln = MetricFu::LineNumbers.new(File.read("#{resources_path}/line_numbers/foo.rb"))
+      ln = MetricFu::LineNumbers.new(FIXTURE_DATA["foo.rb"])
       ln.method_at_line(3).should == "Foo::awesome"
     end
 
     it "should know the name of a private method at a particular line" do
-      ln = MetricFu::LineNumbers.new(File.read("#{resources_path}/line_numbers/foo.rb"))
+      ln = MetricFu::LineNumbers.new(FIXTURE_DATA["foo.rb"])
       ln.method_at_line(28).should == "Foo#whoop"
     end
 
     it "should know the name of a class method defined in a 'class << self block at a particular line" do
-      ln = MetricFu::LineNumbers.new(File.read("#{resources_path}/line_numbers/foo.rb"))
+      ln = MetricFu::LineNumbers.new(FIXTURE_DATA["foo.rb"])
       ln.method_at_line(22).should == "Foo::neat"
     end
 
     it "should know the name of an instance method at a particular line in a file with two classes" do
-      ln = MetricFu::LineNumbers.new(File.read("#{resources_path}/line_numbers/two_classes.rb"))
+      ln = MetricFu::LineNumbers.new(FIXTURE_DATA["two_classes.rb"])
       ln.method_at_line(3).should == "Foo#stuff"
       ln.method_at_line(9).should == "Bar#stuff"
     end
 
     it "should work with modules" do
-      ln = MetricFu::LineNumbers.new(File.read("#{resources_path}/line_numbers/module.rb"))
+      ln = MetricFu::LineNumbers.new(FIXTURE_DATA["module.rb"])
       ln.method_at_line(4).should == 'KickAss#get_beat_up?'
     end
 
     it "should work with module surrounding class" do
-      ln = MetricFu::LineNumbers.new(File.read("#{resources_path}/line_numbers/module_surrounds_class.rb"))
+      ln = MetricFu::LineNumbers.new(FIXTURE_DATA["module_surrounds_class.rb"])
       ln.method_at_line(5).should == "StuffModule::ThingClass#do_it"
       # ln.method_at_line(12).should == "StuffModule#blah" #why no work?
     end