metric_fu 4.4.0 → 4.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 741f0378823b8b42fce3ad9e4bc36b0312988660
-  data.tar.gz: 66dce50c5876c8dc84d672e5ed5571e6e9854dd5
+  metadata.gz: 5b6391c40e351ab9265635b6b35f32662bbe450c
+  data.tar.gz: eb534c71875d84de4e477332a365de843ec7dfb3
 SHA512:
-  metadata.gz: fc38e9dfd106e6f8c92d9f044a3ee1d9d192d6ae3de367b871efa70bc40bd7c67f877f6bc9628440c05094284eb333a635d96c9626e05f2e79f6be4aacd79b14
-  data.tar.gz: 1487b7c82f5f8bf932bbd81b1b538fdd0bf03216fd32af2b3c3f294c7d83edd808cae889f827b1c4e0b788667593f2d0f9e159ce149beb7396b1cd29bd270267
+  metadata.gz: 7a9d4acd5a6b37a5ce18219ff9e8e363395e7f8c65f0fcaae138f0c6660172eefd49006371df55fd1cad2984e30cd91ccc64aaf6d7d1e170d1c37d2e6d3c9e12
+  data.tar.gz: c6dd298de619f6628ae7c5b46026bc7819ff38a9912f1bdd1e13da5e7b70fee82446397b3e6eb08fe602db6e3a7a78f395739874d95e357a6efda95e9eaa5acc

data/HISTORY.md

@@ -10,6 +10,18 @@ As such, a _Feature_ would map to either major or minor. A _bug fix_ to a patch.
 * Fixes
 * Misc
 
+### MetricFu [4.4.1 / 2013-08-29](https://github.com/metricfu/metric_fu/compare/v4.4.0...v4.4.1)
+
+* Features
+* Fixes
+  * No longer consider an ampty sexp in LineNumbers an error.  A file with only comments is empty of code. (Benjamin Fleischer)
+  * Prevent encoding errors when using syntax highlighting via coderay (Benjamin Fleischer #120, #131)
+* Misc
+  * Update dependencies: cane, flay, flog, reek; switch from metric_fu-roodi to revived roodi (Benjamin Fleischer #130)
+  * Update to fully ruby_parser-compatible rails_best_practices (Benjamin Fleischer #133)
+  * Hotspots: remove legacy test code, reduce duplication (Benjamin Fleischer, #127, #77)
+  * Remove a lot of dead code (Benjamin Fleischer, #77)
+
 ### MetricFu 4.4.0 / 2013-08-15
 
 * Features

data/Rakefile

@@ -6,7 +6,6 @@ Dir['./gem_tasks/*.rake'].each do |task|
   import(task)
 end
 
-# $LOAD_PATH << '.'
 begin
   require 'spec/rake/spectask'
   desc "Run all specs in spec directory"

data/bin/mf-roodi

@@ -5,5 +5,5 @@ require 'rubygems'
 require 'metric_fu_requires'
 
 version = MetricFu::MetricVersion.roodi
-gem 'metric_fu-roodi', version
-load Gem.bin_path('metric_fu-roodi', 'metric_fu-roodi', version)
+gem 'roodi', version
+load Gem.bin_path('roodi', 'roodi', version)

data/checksum/metric_fu-4.4.0.gem.sha512

@@ -1 +1 @@
-1f9be27229b5a441bc4e4367d099f6f92641d994246b88f9a396fc8c99d832a00412fe7c9a5dc5078c9beecc8d77d575d9b9ab55b50ab7b0b7583130763369bf
+c01694dc4a374806bd6cfaf5091808d223db1ea07a85d90a9749ed8e603c3abee283a36a6aacde81072b7c0ec2eec64f85d977caa6cd69687a532040a2137bd4

data/gem_tasks/build.rake

@@ -2,37 +2,25 @@
 desc 'override bundler release task'
 task :release => ['build'] do
   STDOUT.puts "Running Bundler Release Task Override"
+  Rake::Task['checksum'].invoke
 end
 require 'bundler/gem_tasks'
 
 GEMSPEC = Bundler::GemHelper.gemspec
 
-# bundler-free alternative
-# packaging
-# https://github.com/YorickPeterse/ruby-lint/blob/master/Rakefile
-# require 'rubygems/package_task'
-# GEMSPEC = Gem::Specification.load('metric_fu.gemspec')
-#
-# Gem::PackageTask.new(GEMSPEC) do |pkg|
-#   pkg.need_tar = false
-#   pkg.need_zip = false
-# end
-
-# gem signing
-# desc 'Builds and signs a new Gem'
-# task :build => [:gem] do
-#   name = "#{GEMSPEC.name}-#{GEMSPEC.version}.gem"
-#   path = File.join(File.expand_path('../../pkg', __FILE__), name)
-#
-#   sh("gem sign #{path}")
-#
-#   Rake::Task['checksum'].invoke
-# end
+desc 'Builds and signs a new Gem'
+task :signed_build => [:build] do
+  name = "#{GEMSPEC.name}-#{GEMSPEC.version}.gem"
+  path = File.join(File.expand_path('../../pkg', __FILE__), name)
 
+  sh("gem sign #{path}")
+
+  Rake::Task['checksum'].invoke
+end
 require 'digest/sha2'
 
 desc 'Creates a SHA512 checksum of the current version'
-task :checksum => ['build']  do
+task :checksum  do
   checksums = File.expand_path('../../checksum', __FILE__)
   name      = "#{GEMSPEC.name}-#{GEMSPEC.version}.gem"
   path      = File.join(File.expand_path('../../pkg', __FILE__), name)
@@ -44,3 +32,17 @@ task :checksum => ['build']  do
     handle.write(checksum)
   end
 end
+
+desc 'Creates a Git tag for the current version'
+task :tag do
+  version = MetricFu::VERSION
+
+  sh %Q{git tag -a -m "Version #{version}" -s #{version}}
+end
+
+desc 'Extracts TODO tags and the likes'
+task :todo do
+  regex = %w{NOTE: FIXME: TODO: THINK: @todo}.join('|')
+
+  sh "ack '#{regex}' lib"
+end

data/lib/metric_fu/configuration.rb

@@ -19,16 +19,6 @@ module MetricFu
     end
   end
 
-  # TODO: Remove this method.  It is really a test concern for identifying
-  #   metrics turned off for environmental reasons
-  def self.mri_only_metrics
-    if MetricFu.configuration.mri?
-      []
-    else
-      [:cane, :flog, :rails_best_practices]
-    end
-  end
-
   # = Configuration
   #
   # The Configuration class, as it sounds, provides methods for

data/lib/metric_fu/data_structures/line_numbers.rb

@@ -16,6 +16,8 @@ module MetricFu
         @locations = {}
         file_sexp = rp.parse(contents)
         case file_sexp[0]
+        when nil
+          mf_log "No ruby code found in #{file_path}"
         when :class
           process_class(file_sexp)
         when :module

data/lib/metric_fu/initial_requires.rb

@@ -8,7 +8,6 @@ require 'redcard'
 require 'multi_json'
 
 MetricFu.configure
-MetricFu.lib_require { 'parser_ext' }
 MetricFu.logging_require { 'mf_debugger' }
 include MfDebugger
 MfDebugger::Logger.debug_on = !!(ENV['MF_DEBUG'] =~ /true/i)

data/lib/metric_fu/metric.rb

@@ -20,7 +20,7 @@ module MetricFu
       @libraries.each {|library| require(library) }
       self.activated = true
     rescue LoadError => e
-      MetricFu.configuration.mf_log("#{name} metric not activated, #{e.message}")
+      mf_log "#{name} metric not activated, #{e.message}"
     end
 
     # @return metric name [Symbol]

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

@@ -1,5 +1,4 @@
-class ChurnHotspot < MetricFu::Hotspot
-  include MetricFu::HotspotScoringStrategies
+class MetricFu::ChurnHotspot < MetricFu::Hotspot
 
   COLUMNS = %w{times_changed}
 
@@ -11,15 +10,19 @@ class ChurnHotspot < MetricFu::Hotspot
     :churn
   end
 
-  def map(row)
-    MetricFu::HotspotScoringStrategies.present(row)
+  def map_strategy
+    :present
   end
 
-  def reduce(scores)
-    MetricFu::HotspotScoringStrategies.sum(scores)
+  def reduce_strategy
+    :sum
   end
 
-  def score(metric_ranking, item)
+  def score_strategy
+    :calculate_score
+  end
+
+  def calculate_score(metric_ranking, item)
     flat_churn_score = 0.50
     metric_ranking.scored?(item) ? flat_churn_score : 0
   end
@@ -39,8 +42,4 @@ class ChurnHotspot < MetricFu::Hotspot
     "detected high level of churn (changed #{group[0].times_changed} times)"
   end
 
-  def present_group_details(group)
-    "detected high level of churn (changed #{group[0].times_changed} times)"
-  end
-
 end

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

@@ -1,5 +1,4 @@
-class FlayHotspot < MetricFu::Hotspot
-  include MetricFu::HotspotScoringStrategies
+class MetricFu::FlayHotspot < MetricFu::Hotspot
 
   COLUMNS = %w{flay_reason flay_matching_reason}
 
@@ -11,16 +10,16 @@ class FlayHotspot < MetricFu::Hotspot
     :flay
   end
 
-  def map(row)
-    MetricFu::HotspotScoringStrategies.present(row)
+  def map_strategy
+    :present
   end
 
-  def reduce(scores)
-    MetricFu::HotspotScoringStrategies.sum(scores)
+  def reduce_strategy
+    :sum
   end
 
-  def score(metric_ranking, item)
-    MetricFu::HotspotScoringStrategies.percentile(metric_ranking, item)
+  def score_strategy
+    :percentile
   end
 
   def generate_records(data, table)
@@ -52,16 +51,4 @@ class FlayHotspot < MetricFu::Hotspot
     "found #{occurences} code duplications"
   end
 
-  def present_group_details(group)
-    occurences = group.size
-    message = "found #{occurences} code duplications<br/>"
-    group.each do |item|
-      problem    = item.data["flay_reason"]
-      problem    = problem.gsub(/^[0-9]*\)/,'')
-      problem    = problem.gsub(/files\:/,' <br>&nbsp;&nbsp;&nbsp;files:')
-      message << "* #{problem}<br/>"
-    end
-    message
-  end
-
 end

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

@@ -1,5 +1,4 @@
-class FlogHotspot < MetricFu::Hotspot
-  include MetricFu::HotspotScoringStrategies
+class MetricFu::FlogHotspot < MetricFu::Hotspot
 
   COLUMNS = %w{score}
 
@@ -11,16 +10,16 @@ class FlogHotspot < MetricFu::Hotspot
     :flog
   end
 
-  def map(row)
-    row.score
+  def map_strategy
+    :score
   end
 
-  def reduce(scores)
-    MetricFu::HotspotScoringStrategies.average(scores)
+  def reduce_strategy
+    :average
   end
 
-  def score(metric_ranking, item)
-    MetricFu::HotspotScoringStrategies.identity(metric_ranking, item)
+  def score_strategy
+    :identity
   end
 
   def generate_records(data, table)
@@ -46,10 +45,4 @@ class FlogHotspot < MetricFu::Hotspot
     "#{"average " if occurences > 1}complexity is %.1f" % complexity
   end
 
-  def present_group_details(group)
-    occurences = group.size
-    complexity = get_mean(group.column("score"))
-    "#{"average " if occurences > 1}complexity is %.1f" % complexity
-  end
-
 end

data/lib/metric_fu/metrics/generator.rb

@@ -54,20 +54,6 @@ module MetricFu
       @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
-    # the #generate_result instance method.
-    #
-    # @params options Hash
-    #   A currently unused hash to configure the Generator
-    #
-    # @see generate_result
-    def self.generate_result(options={})
-      generator = self.new(options)
-      generator.generate_result
-    end
-
     # Provides the unqualified class name of an implemented concrete
     # class, as a string.  For example:
     #

data/lib/metric_fu/metrics/graph.rb

@@ -6,36 +6,71 @@ module MetricFu
 
   class Graph
 
-    attr_accessor :clazz
+    attr_accessor :graphers
 
     def initialize
-      self.clazz = []
+      self.graphers = []
     end
 
     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 }
+      grapher = grapher_from_type_and_engine(graph_type, graph_engine)
+      self.graphers.push grapher.new.tap{|g| g.output_directory = output_directory }
+    rescue NameError => e
+      mf_log "#{e.message} called in MetricFu::Graph.add with #{graph_type}"
     end
 
 
     def generate
-      return if self.clazz.empty?
+      return if self.graphers.empty?
       mf_log "Generating graphs"
-      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))
-
-        self.clazz.each do |grapher|
-          grapher.get_metrics(metrics, "#{date_parts[:m]}/#{date_parts[:d]}")
-        end
+      generate_graphs_for_files
+      graph!
+    rescue NameError => e
+      mf_log "#{e.message} called in MetricFu::Graph generate"
+    end
+
+    private
+
+    def grapher_from_type_and_engine(graph_type, graph_engine)
+      grapher_name = graph_type.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase } + graph_engine.to_s.capitalize + "Grapher"
+      MetricFu.const_get(grapher_name)
+    end
+    def metric_files
+      Dir[File.join(MetricFu::Io::FileSystem.directory('data_directory'), '*.yml')].sort
+    end
+
+    def generate_graphs_for_files
+      metric_files.each do |metric_file|
+        generate_graphs_for_file(metric_file)
+      end
+    end
+
+    def generate_graphs_for_file(metric_file)
+      mf_log "Generating graphs for #{metric_file}"
+      date_parts = year_month_day_from_filename(metric_file)
+      metrics = load_yaml_metric_file(metric_file)
+
+      build_graph(metrics, "#{date_parts[:m]}/#{date_parts[:d]}")
+    rescue NameError => e
+      mf_log "#{e.message} called in MetricFu::Graph.generate with #{metric_file}"
+    end
+
+    def load_yaml_metric_file(metric_file)
+      YAML.load(File.open(metric_file))
+    end
+
+    def build_graph(metrics, sortable_prefix)
+      self.graphers.each do |grapher|
+        grapher.get_metrics(metrics, sortable_prefix)
       end
-      self.clazz.each do |grapher|
+    end
+
+    def graph!
+      self.graphers.each do |grapher|
         grapher.graph!
       end
     end
 
-    private
     def year_month_day_from_filename(path_to_file_with_date)
       date = path_to_file_with_date.match(/\/(\d+).yml$/)[1]
       {:y => date[0..3].to_i, :m => date[4..5].to_i, :d => date[6..7].to_i}

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

@@ -7,41 +7,35 @@ module MetricFu
       @analyzer_tables = analyzer_tables
     end
     def worst_items
-      num = nil
       worst_items = {}
-      worst_items[:files] =
-        @hotspot_rankings.worst_files(num).inject([]) do |array, worst_file|
-        array <<
-          {:location => self.location(:file, worst_file),
-          :details => self.problems_with(:file, worst_file)}
-        array
-      end
-      worst_items[:classes] = @hotspot_rankings.worst_classes(num).inject([]) do |array, class_name|
-        location = self.location(:class, class_name)
-        array <<
-          {:location => location,
-          :details => self.problems_with(:class, class_name)}
-        array
-      end
-      worst_items[:methods] = @hotspot_rankings.worst_methods(num).inject([]) do |array, method_name|
-        location = self.location(:method, method_name)
-        array <<
-          {:location => location,
-          :details => self.problems_with(:method, method_name)}
-        array
-      end
+      worst_items[:files]   = worst(@hotspot_rankings.worst_files,   :file)
+      worst_items[:classes] = worst(@hotspot_rankings.worst_classes, :class)
+      worst_items[:methods] = worst(@hotspot_rankings.worst_methods, :method)
       worst_items
     end
+
     private
-    #todo redo as item,value, options = {}
+
+    # @param rankings [Array<MetricFu::HotspotRankings>]
+    # @param granularity [Symbol] one of :class, :method, :file
+    def worst(rankings,granularity)
+      rankings.map do |ranked_item_name|
+        location = location(granularity, ranked_item_name)
+        details = problems_with(granularity, ranked_item_name)
+        {:location => location, :details =>  details}
+      end
+    end
+
+    # @todo redo as item,value, options = {}
     # Note that the other option for 'details' is :detailed (this isn't
     # at all clear from this method itself
-    def problems_with(item, value, details = :summary, exclude_details = [])
+    def problems_with(item, value)
       sub_table = get_sub_table(item, value)
       #grouping = Ruport::Data::Grouping.new(sub_table, :by => 'metric')
       grouping = get_grouping(sub_table, :by => 'metric')
-      MetricFu::HotspotProblems.new(grouping, details, exclude_details).problems
+      MetricFu::HotspotProblems.new(grouping).problems
     end
+
     def location(item, value)
       sub_table = get_sub_table(item, value)
       assert_sub_table_has_data(item, sub_table, value)
@@ -64,14 +58,14 @@ module MetricFu
       end
     end
 
-    # just for testing
-    public :location, :problems_with
     def get_sub_table(item, value)
       tables = @analyzer_tables.tables_for(item)
       tables[value]
     end
+
     def get_grouping(table, opts)
       MetricFu::HotspotGroupings.new(table, opts).get_grouping
     end
+
   end
 end