metric_fu 4.3.1 → 4.4.0

data/lib/metric_fu/metrics/cane/cane.rb

@@ -1,7 +1,11 @@
 module MetricFu
-  class Cane < Generator
+  class CaneGenerator < Generator
     attr_reader :violations, :total_violations
 
+    def self.metric
+      :cane
+    end
+
     def emit
       command = %Q{mf-cane#{abc_max_param}#{style_measure_param}#{no_doc_param}#{no_readme_param}}
       mf_debug "** #{command}"
@@ -19,19 +23,19 @@ module MetricFu
     private
 
     def abc_max_param
-      MetricFu.cane[:abc_max] ? " --abc-max #{MetricFu.cane[:abc_max]}" : ""
+      options[:abc_max] ? " --abc-max #{options[:abc_max]}" : ""
     end
 
     def style_measure_param
-      MetricFu.cane[:line_length] ? " --style-measure #{MetricFu.cane[:line_length]}" : ""
+      options[:line_length] ? " --style-measure #{options[:line_length]}" : ""
     end
 
     def no_doc_param
-      MetricFu.cane[:no_doc] == 'y' ? " --no-doc" : ""
+      options[:no_doc] == 'y' ? " --no-doc" : ""
     end
 
     def no_readme_param
-      MetricFu.cane[:no_readme] == 'y' ? " --no-readme" : ""
+      options[:no_readme] == 'y' ? " --no-readme" : ""
     end
 
     def violations_by_category

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

@@ -1,14 +1,36 @@
-MetricFu::Configuration.run do |config|
-  require 'cane'
-  config.add_metric(:cane)
-  config.add_graph(:cane)
-  config.configure_metric(:cane, {
-    :dirs_to_cane => MetricFu.code_dirs,
-    :abc_max => 15,
-    :line_length => 80,
-    :no_doc => 'n',
-    :no_readme => 'n',
-    :filetypes => ['rb']
-  })
-end
+module MetricFu
+  class MetricCane < Metric
+
+    def name
+      :cane
+    end
+
+    def default_run_options
+      {
+        :dirs_to_cane => MetricFu::Io::FileSystem.directory('code_dirs'),
+        :abc_max => 15,
+        :line_length => 80,
+        :no_doc => 'n',
+        :no_readme => 'n',
+        :filetypes => ['rb']
+      }
+    end
+
+    def has_graph?
+      true
+    end
 
+    def enable
+      if MetricFu.configuration.supports_ripper? && !MetricFu.configuration.ruby18?
+        super
+      else
+        MetricFu.configuration.mf_debug("Cane is only available in MRI. It requires ripper and 1.9 hash syntax support")
+      end
+    end
+
+    def activate
+      super
+    end
+
+  end
+end

data/lib/metric_fu/metrics/churn/churn.rb

@@ -1,6 +1,10 @@
 module MetricFu
 
-  class Churn < Generator
+  class ChurnGenerator < Generator
+
+    def self.metric
+      :churn
+    end
 
     def emit
       @output = generate_churn_metrics

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

@@ -1,5 +1,25 @@
-MetricFu::Configuration.run do |config|
-  config.add_metric(:churn)
-  config.configure_metric(:churn,
-        { :start_date => %q("1 year ago"), :minimum_churn_count => 10})
+module MetricFu
+  class MetricChurn < Metric
+
+    def name
+      :churn
+    end
+
+    def default_run_options
+      { :start_date => %q("1 year ago"), :minimum_churn_count => 10}
+    end
+
+    def has_graph?
+      false
+    end
+
+    def enable
+      super
+    end
+
+    def activate
+      super
+    end
+
+  end
 end

data/lib/metric_fu/metrics/flay/flay.rb

@@ -1,11 +1,15 @@
 module MetricFu
 
-  class Flay < Generator
+  class FlayGenerator < Generator
+
+    def self.metric
+      :flay
+    end
 
     def emit
-      minimum_score_parameter = MetricFu.flay[:minimum_score] ? "--mass #{MetricFu.flay[:minimum_score]} " : ""
+      minimum_score_parameter = options[:minimum_score] ? "--mass #{options[:minimum_score]} " : ""
 
-      command = %Q(mf-flay #{minimum_score_parameter} #{MetricFu.flay[:dirs_to_flay].join(" ")})
+      command = %Q(mf-flay #{minimum_score_parameter} #{options[:dirs_to_flay].join(" ")})
       mf_debug "** #{command}"
       @output = `#{command}`
     end

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

@@ -1,14 +1,30 @@
-MetricFu::Configuration.run do |config|
-  require 'flay'
-  config.add_metric(:flay)
-  config.add_graph(:flay)
-  config.configure_metric(:flay,
-                    { :dirs_to_flay => MetricFu.code_dirs, # was @code_dirs
-                      # MetricFu has been setting the minimum score as 100 for
-                      # a long time. This is a really big number, considering
-                      # the default is 16. Commenting it out for documentation
-                      # of the setting, but to use the Flay default.
-                      # :minimum_score => 100,
-                      :filetypes => ['rb'] }
-                          )
+module MetricFu
+  class MetricFlay < Metric
+
+    def name
+      :flay
+    end
+
+    def default_run_options
+      { :dirs_to_flay => MetricFu::Io::FileSystem.directory('code_dirs'),
+      # MetricFu has been setting the minimum score as 100 for
+      # a long time. This is a really big number, considering
+      # the default is 16. Setting it to nil to use the Flay default.
+      :minimum_score => nil,
+      :filetypes => ['rb'] }
+    end
+
+    def has_graph?
+      true
+    end
+
+    def enable
+      super
+    end
+
+    def activate
+      super
+    end
+
+  end
 end

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

@@ -11,7 +11,7 @@
 <% end %>
 
 <h4>Total Score (lower is better): <%= @flay[:total_score] %></h4>
-<h5>Scores less than <%= MetricFu.flay[:minimum_score] %> are not shown or part of the total</h5>
+<h5>Scores less than <%= MetricFu::Metric.get_metric('flay').run_options[:minimum_score] %> are not shown or part of the total</h5>
 
 <table>
   <tr>

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

@@ -1,58 +1,34 @@
 require 'pathname'
 require 'optparse'
-require 'rbconfig'
-class RubyParser
-  alias_method :original_process, :process
-  def process(s,f,t)
-    original_process(s,f,t)
-  rescue => e
-    if e.message =~ /wrong number of arguments/
-      original_process(s,f)
-    else
-      raise
-    end
-  end
-end
+
 module MetricFu
+  class FlogGenerator < Generator
 
-  class Flog < Generator
+    def self.metric
+      :flog
+    end
 
     def emit
-      files = []
-      MetricFu.flog[:dirs_to_flog].each do |directory|
-        directory = "." if directory=='./'
-        dir_files = Dir.glob("#{directory}/**/*.rb")
-        dir_files = remove_excluded_files(dir_files)
-        files += dir_files
-      end
-      options = ::Flog.parse_options [
+      parse_options = FlogCLI.parse_options [
         "--all",
-        MetricFu.flog[:continue] ? "--continue" : nil,
+        options[:continue] ? "--continue" : nil,
       ].compact
-
-      @flogger = ::Flog.new options
-      @flogger.flog files
-
-    rescue LoadError => e
-      message = "#{e.class}\t#{e.message}\n\t#{e.backtrace.join('\n\t')}"
-      if MetricFu.configuration.mri?
-        mf_log "Flog Error: #{message}"
-      else
-        mf_log "Flog tasks only available in MRI: #{message}"
-      end
+      @flogger = FlogCLI.new parse_options
+      @flogger.flog *options[:dirs_to_flog]
     end
 
     def analyze
       @method_containers = {}
-      @flogger.calls.each do |full_method_name, operators|
+      @flogger.calculate
+      @flogger.each_by_score do |full_method_name, score, operators|
         container_name = full_method_name.split('#').first
         path = @flogger.method_locations[full_method_name]
         if @method_containers[container_name]
-          @method_containers[container_name].add_method(full_method_name, operators, @flogger.totals[full_method_name], path)
+          @method_containers[container_name].add_method(full_method_name, operators, score, path)
           @method_containers[container_name].add_path(path)
         else
           mc = MethodContainer.new(container_name, path)
-          mc.add_method(full_method_name, operators, @flogger.totals[full_method_name], path)
+          mc.add_method(full_method_name, operators, score, path)
           @method_containers[container_name] = mc
         end
       end
@@ -60,7 +36,7 @@ module MetricFu
 
     def to_h
       sorted_containers = @method_containers.values.sort_by {|c| c.highest_score}.reverse
-      {:flog => { :total => @flogger.total,
+      {:flog => { :total => @flogger.total_score,
                   :average => @flogger.average,
                   :method_containers => sorted_containers.map {|method_container| method_container.to_h}}}
     end

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

@@ -1,8 +1,31 @@
-MetricFu::Configuration.run do |config|
-  require 'flog'
-  config.add_metric(:flog)
-  config.add_graph(:flog)
-  config.configure_metric(:flog,
-                          { :dirs_to_flog => MetricFu.code_dirs  }
-                          )
+module MetricFu
+  class MetricFlog < Metric
+
+    def name
+      :flog
+    end
+
+    def default_run_options
+      { :dirs_to_flog => MetricFu::Io::FileSystem.directory('code_dirs'), :continue => true, :all => true, :quiet => true  }
+    end
+
+    def has_graph?
+      true
+    end
+
+    def enable
+      if MetricFu.configuration.mri?
+        super
+      else
+        MetricFu.configuration.mf_debug("Flog is only available in MRI due to flog tasks")
+      end
+    end
+
+    def activate
+      activate_library 'flog'
+      activate_library 'flog_cli'
+      super
+    end
+
+  end
 end

data/lib/metric_fu/metrics/generator.rb

@@ -1,3 +1,4 @@
+require 'fileutils'
 module MetricFu
 
   # = Generator
@@ -39,6 +40,20 @@ module MetricFu
       create_data_dir_if_missing
     end
 
+    @generators = []
+    # @return all subclassed generators [Array<MetricFu::Generator>]
+    def self.generators
+      @generators
+    end
+
+    def self.get_generator(metric)
+      generators.find{|generator|generator.metric.to_s == metric.to_s.downcase}
+    end
+
+    def self.inherited(subclass)
+      @generators << subclass
+    end
+
     # Creates a new generator and returns the output of the
     # #generate_result method.  This is the typical way to
     # generate a new MetricFu result. For more information see
@@ -70,7 +85,7 @@ module MetricFu
 
     # Returns the directory where the Generator will write any output
     def self.metric_directory
-      File.join(MetricFu.scratch_directory, class_name)
+      File.join(MetricFu::Io::FileSystem.directory('scratch_directory'), class_name)
     end
 
     def create_metric_dir_if_missing #:nodoc:
@@ -80,14 +95,14 @@ module MetricFu
     end
 
     def create_output_dir_if_missing #:nodoc:
-      unless File.directory?(MetricFu.output_directory)
-        FileUtils.mkdir_p(MetricFu.output_directory, :verbose => false)
+      unless File.directory?(MetricFu::Io::FileSystem.directory('output_directory'))
+        FileUtils.mkdir_p(MetricFu::Io::FileSystem.directory('output_directory'), :verbose => false)
       end
     end
 
     def create_data_dir_if_missing #:nodoc:
-      unless File.directory?(MetricFu.data_directory)
-        FileUtils.mkdir_p(MetricFu.data_directory, :verbose => false)
+      unless File.directory?(MetricFu::Io::FileSystem.directory('data_directory'))
+        FileUtils.mkdir_p(MetricFu::Io::FileSystem.directory('data_directory'), :verbose => false)
       end
     end
 
@@ -97,7 +112,7 @@ module MetricFu
       self.class.metric_directory
     end
 
-    def remove_excluded_files(paths, globs_to_remove = MetricFu.file_globs_to_ignore)
+    def remove_excluded_files(paths, globs_to_remove = MetricFu::Io::FileSystem.file_globs_to_ignore)
       files_to_remove = []
       globs_to_remove.each do |glob|
         files_to_remove.concat(Dir[glob])

data/lib/metric_fu/metrics/graph.rb

@@ -12,7 +12,7 @@ module MetricFu
       self.clazz = []
     end
 
-    def add(graph_type, graph_engine, output_directory = MetricFu.output_directory)
+    def add(graph_type, graph_engine, output_directory = MetricFu::Io::FileSystem.directory('output_directory'))
       grapher_name = graph_type.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase } + graph_engine.to_s.capitalize + "Grapher"
       self.clazz.push MetricFu.const_get(grapher_name).new.tap{|g| g.output_directory = output_directory }
     end
@@ -21,7 +21,7 @@ module MetricFu
     def generate
       return if self.clazz.empty?
       mf_log "Generating graphs"
-      Dir[File.join(MetricFu.data_directory, '*.yml')].sort.each do |metric_file|
+      Dir[File.join(MetricFu::Io::FileSystem.directory('data_directory'), '*.yml')].sort.each do |metric_file|
         mf_log "Generating graphs for #{metric_file}"
         date_parts = year_month_day_from_filename(metric_file)
         metrics = YAML::load(File.open(metric_file))

data/lib/metric_fu/metrics/hotspots/hotspots.rb

@@ -1,7 +1,11 @@
 MetricFu.metrics_require   { 'hotspots/hotspot_analyzer' }
 module MetricFu
 
-  class Hotspots < Generator
+  class HotspotsGenerator < Generator
+
+    def self.metric
+      :hotspots
+    end
 
     def initialize(options={})
       super

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

@@ -1,6 +1,22 @@
-# TODO remove explicit Churn dependency
-MetricFu::Configuration.run do |config|
-  config.add_metric(:hotspots)
-  config.configure_metric(:hotspots,
-      { :start_date => "1 year ago", :minimum_churn_count => 10})
+module MetricFu
+  class MetricHotspots < Metric
+
+    def name
+      :hotspots
+    end
+
+    # TODO remove explicit Churn dependency
+    def default_run_options
+      { :start_date => "1 year ago", :minimum_churn_count => 10}
+    end
+
+    def has_graph?
+      false
+    end
+
+    def enable
+      super
+    end
+
+  end
 end