metric_fu 2.1.3.4 → 2.1.3.5

data/{HISTORY → HISTORY.md}

@@ -1,3 +1,19 @@
+=== MetricFu 2.1.3.5 / 2013-01-01
+
+* Issue #35, Namespace MetricFu::Table. -Benjamin Fleischer
+* Additionally namespace
+  * MetricFu::CodeIssue
+  * MetricFu::MetricAnalyzer
+  * MetricFu::AnalysisError
+  * MetricFu::HotspotScoringStrategies
+* Rename MetricAnalyzer to HotspotAnalyzer, and rename all <metric>Analzyer classes to <metric>Hotspot to signify that they are part of the Hotspot code -Benjamin Fleischer
+
+=== MetricFu 2.1.3.4 / 2012-12-28
+
+* Restructuring of the project layout
+* Project is now at https://github.com/metricfu/metric_fu and gem is again metric_fu
+* Can run tasks as `metric_fu` command
+
 === MetricFu 2.1.3.2 / 2012-11-14
 
 * Don't raise an exception in the LineNumbers rescue block. Issue https://github.com/bf4/metric_fu/issues/6 by joonty -Benjamin Fleischer
@@ -17,7 +33,7 @@
 * Getting it working on Rails 3, partly by going through the pull requests and setting gem dependencies to older, working versions - Benjamin Fleischer
 * It mostly works on Ruby 1.9, though there is an unresolved sexp_parser issue  - Benjamin Fleischer
 * Added link_prefix to configuration to allow URIs specified in config instead of file or txmt - dan sinclair
- 
+
 === MetricFu 2.1.1 / 2011-03-2
 
 * Making syntax highlighting optional (config.syntax_highlighting = false) so Ruby 1.9.2 users don't get "invalid byte sequence in UTF-8" errors.
@@ -31,7 +47,7 @@
 * Stefan Huber fixed some problems with churn pretending not to support Svn.
 * Kakutani Shintaro added the ability to opt out of opening files with TextMate (config.darwin_txmt_protocol_no_thanks = true).
 * Joel Nimety and Andrew Selder fixed a problem where Saikuro was parsing a dir twice.
-* Dan Sinclair added some awesome 'annotate' functionality to the Hotspots page. Click on it so see the file with problems in-line. 
+* Dan Sinclair added some awesome 'annotate' functionality to the Hotspots page. Click on it so see the file with problems in-line.
 * Dan Sinclair added a verbose mode (config.verbose = true).
 
 === MetricFu 2.0.1 / 2010-11-13

data/README.md

@@ -1,8 +1,12 @@
-This fork is intended to be a maintained version of metric_fu, as [the original version by Jake Scruggs has been abandoned.](http://jakescruggs.blogspot.com/2012/08/why-i-abandoned-metricfu.html). It is currently testing on MRI 1.8.7 and 1.9.3
+This is the official repository for metric_fu.
 
-At this time, the gem is published on rubygems.org as bf4-metric_fu
+It is currently testing on MRI 1.8.7 and 1.9.3
 
-There is also a related bf4-metrical gem published
+The original repository by Jake Scruggs at [https://github.com/jscruggs/metric_fu](https://github.com/jscruggs/metric_fu) [has been deprecated.](http://jakescruggs.blogspot.com/2012/08/why-i-abandoned-metricfu.html).
+
+The gem is published on rubygems.org as metric_fu
+
+There is also a related metricfu-metrical gem published
 
 The japgolly-Saikuro fork is a part of an attempt to get metric_fu working in a modern
 
@@ -12,13 +16,13 @@ Ruby environment, specifically compatibility with Ruby 1.9 and Bundler.
 
 __CI Build Status__
 
-[![Build Status](https://secure.travis-ci.org/bf4/metric_fu.png)](http://travis-ci.org/bf4/metric_fu)
+[![Build Status](https://secure.travis-ci.org/metricfu/metric_fu.png)](http://travis-ci.org/metricfu/metric_fu)
 
 This project runs [travis-ci.org](http://travis-ci.org)
 
 __Code Quality__
 
-[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/bf4/metric_fu)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/metricfu/metric_fu)
 
 This project runs [https://codeclimate.com/](https://codeclimate.com/)
 
@@ -48,8 +52,8 @@ The more of the above steps you do the easier it will be for me to merge in whic
 
 Resources:
 
-Github: http://github.com/bf4/metric_fu
-Issue Tracker: http://github.com/bf4/metric_fu/issues
+Github: http://github.com/metricfu/metric_fu
+Issue Tracker: http://github.com/metricfu/metric_fu/issues
 My Blog: http://benjaminfleischer.com
 
 Original Resources:

data/TODO

@@ -5,4 +5,5 @@
 * Color code flog results with scale from: http://jakescruggs.blogspot.com/2008/08/whats-good-flog-score.html
 * Make running metric_fu on metric_fu less embarrassing
 * Load all gems at config time so you fail fast if one is missing
+* Look into removing rcov and churn, and adding laser, brakeman, and/or cane
 

data/lib/data_structures/careful_array.rb

@@ -1,9 +1,11 @@
-module CarefulArray
+module MetricFu
+  module CarefulArray
 
-  def carefully_remove(elements)
-    missing_elements = elements - self
-    raise "Cannot delete missing elements: #{missing_elements.inspect}" unless missing_elements.empty?
-    (self - elements).extend(CarefulArray)
-  end
+    def carefully_remove(elements)
+      missing_elements = elements - self
+      raise "Cannot delete missing elements: #{missing_elements.inspect}" unless missing_elements.empty?
+      (self - elements).extend(MetricFu::CarefulArray)
+    end
 
+  end
 end

data/lib/data_structures/code_issue.rb

@@ -1,98 +1,102 @@
 require 'delegate'
 
-[ 'metric_analyzer',
-  'flog/flog_analyzer',
-  'saikuro/saikuro_analyzer',
-  'churn/churn_analyzer',
-  'reek/reek_analyzer',
-  'flay/flay_analyzer'].each do |path|
+[ 'hotspot_analyzer',
+  'flog/flog_hotspot',
+  'saikuro/saikuro_hotspot',
+  'churn/churn_hotspot',
+  'reek/reek_hotspot',
+  'flay/flay_hotspot'].each do |path|
   MetricFu.metrics_require { path }
 end
-MetricFu.data_structures_require { 'careful_array' }
+%w(careful_array record).each do |path|
+  MetricFu.data_structures_require { path }
+end
 
-class CodeIssue < DelegateClass(MetricFu::Record) #DelegateClass(Ruport::Data::Record)
-  include Comparable
+module MetricFu
+  class CodeIssue < DelegateClass(MetricFu::Record) #DelegateClass(Ruport::Data::Record)
+    include Comparable
 
-  # TODO: Yuck! 'stat_value' is a column for StatAnalyzer
-  EXCLUDED_COLUMNS =
-    FlogAnalyzer::COLUMNS +
-    SaikuroAnalyzer::COLUMNS +
-    ['stat_value'] +
-    ChurnAnalyzer::COLUMNS +
-    ReekAnalyzer.new.columns.extend(CarefulArray).carefully_remove(['reek__type_name',
-    'reek__comparable_message']) +
-    FlayAnalyzer.new.columns.extend(CarefulArray).carefully_remove(['flay_matching_reason'])
+    # TODO: Yuck! 'stat_value' is a column for StatHotspot
+    EXCLUDED_COLUMNS =
+      FlogHotspot::COLUMNS +
+      SaikuroHotspot::COLUMNS +
+      ['stat_value'] +
+      ChurnHotspot::COLUMNS +
+      ReekHotspot.new.columns.extend(MetricFu::CarefulArray).carefully_remove(['reek__type_name',
+      'reek__comparable_message']) +
+      FlayHotspot.new.columns.extend(MetricFu::CarefulArray).carefully_remove(['flay_matching_reason'])
 
-  def <=>(other)
-    spaceship_for_columns(self.attributes, other)
-  end
+    def <=>(other)
+      spaceship_for_columns(self.attributes, other)
+    end
 
-  def ===(other)
-    self.hash_for(included_columns_hash, included_columns) == other.hash_for(included_columns_hash, included_columns)
-  end
+    def ===(other)
+      self.hash_for(included_columns_hash, included_columns) == other.hash_for(included_columns_hash, included_columns)
+    end
 
-  def spaceship_for_columns(columns, other)
-    columns.each do |column|
-      equality = self[column].to_s <=> other[column].to_s
-      return equality if equality!=0
+    def spaceship_for_columns(columns, other)
+      columns.each do |column|
+        equality = self[column].to_s <=> other[column].to_s
+        return equality if equality!=0
+      end
+      return 0
     end
-    return 0
-  end
 
-  def hash_for(column_hash, columns)
-    @hashes ||= {}
-    # fetch would be cleaner, but slower
-    if @hashes.has_key?(column_hash)
-      @hashes[column_hash]
-    else
-      values = columns.map {|column| self[column]}
-      hash_for_columns = values.join('').hash
-      @hashes[column_hash]=hash_for_columns
-      hash_for_columns
+    def hash_for(column_hash, columns)
+      @hashes ||= {}
+      # fetch would be cleaner, but slower
+      if @hashes.has_key?(column_hash)
+        @hashes[column_hash]
+      else
+        values = columns.map {|column| self[column]}
+        hash_for_columns = values.join('').hash
+        @hashes[column_hash]=hash_for_columns
+        hash_for_columns
+      end
     end
-  end
 
-  def included_columns_hash
-    @included_columns_hash ||= included_columns.hash
-  end
+    def included_columns_hash
+      @included_columns_hash ||= included_columns.hash
+    end
 
-  def included_columns
-    @included_columns ||= self.attributes.extend(CarefulArray).carefully_remove(EXCLUDED_COLUMNS)
-  end
+    def included_columns
+      @included_columns ||= self.attributes.extend(MetricFu::CarefulArray).carefully_remove(EXCLUDED_COLUMNS)
+    end
 
-  def find_counterpart_index_in(collection)
-    # each_with_index is cleaner, but it is slower and we
-    # spend a lot of time in this loop
-    index = 0
-    collection.each do |issue|
-      return index if self === issue
-      index += 1
+    def find_counterpart_index_in(collection)
+      # each_with_index is cleaner, but it is slower and we
+      # spend a lot of time in this loop
+      index = 0
+      collection.each do |issue|
+        return index if self === issue
+        index += 1
+      end
+      return nil
     end
-    return nil
-  end
 
-  def modifies?(other)
-    case self.metric
-    when :reek
-      #return false unless ["Large Class", "Long Method", "Long Parameter List"].include?(self.reek__type_name)
-      return false if self.reek__type_name != other.reek__type_name
-      self.reek__value != other.reek__value
-    when :flog
-      self.score != other.score
-    when :saikuro
-      self.complexity != other.complexity
-    when :stats
-      self.stat_value != other.stat_value
-    when :churn
-      self.times_changed != other.times_changed
-    when :flay
-      #self.flay_reason != other.flay_reason
-      # do nothing for now
-    when :roodi, :stats
-      # do nothing
-    else
-      raise ArgumentError, "Invalid metric type #{self.metric}"
+    def modifies?(other)
+      case self.metric
+      when :reek
+        #return false unless ["Large Class", "Long Method", "Long Parameter List"].include?(self.reek__type_name)
+        return false if self.reek__type_name != other.reek__type_name
+        self.reek__value != other.reek__value
+      when :flog
+        self.score != other.score
+      when :saikuro
+        self.complexity != other.complexity
+      when :stats
+        self.stat_value != other.stat_value
+      when :churn
+        self.times_changed != other.times_changed
+      when :flay
+        #self.flay_reason != other.flay_reason
+        # do nothing for now
+      when :roodi, :stats
+        # do nothing
+      else
+        raise ArgumentError, "Invalid metric type #{self.metric}"
+      end
     end
-  end
 
+  end
 end

data/lib/data_structures/grouping.rb

@@ -12,12 +12,12 @@ module MetricFu
         hash = table.group_by_metric
       else
         table.each do |row|
-          hash[row[column_name]] ||= Table.new(:column_names => row.attributes)
+          hash[row[column_name]] ||= MetricFu::Table.new(:column_names => row.attributes)
           hash[row[column_name]] << row
         end
       end
       if order
-        @arr = hash.sort_by &order
+        @arr = hash.sort_by(&order)
       else
         @arr = hash.to_a
       end

data/lib/data_structures/table.rb

@@ -1,106 +1,108 @@
-%w(record).each do |path|
+%w(record code_issue).each do |path|
   MetricFu.data_structures_require { path }
 end
 
-class Table
+module MetricFu
+  class Table
 
-  def initialize(opts = {})
-    @rows = []
-    @columns = opts.fetch(:column_names)
+    def initialize(opts = {})
+      @rows = []
+      @columns = opts.fetch(:column_names)
 
-    @make_index = opts.fetch(:make_index) {true}
-    @metric_index = {}
-  end
+      @make_index = opts.fetch(:make_index) {true}
+      @metric_index = {}
+    end
 
-  def <<(row)
-    record = nil
-    if row.is_a?(MetricFu::Record) || row.is_a?(CodeIssue)
-      record = row
-    else
-      record = MetricFu::Record.new(row, @columns)
+    def <<(row)
+      record = nil
+      if row.is_a?(MetricFu::Record) || row.is_a?(MetricFu::CodeIssue)
+        record = row
+      else
+        record = MetricFu::Record.new(row, @columns)
+      end
+      @rows << record
+      updated_key_index(record) if @make_index
     end
-    @rows << record
-    updated_key_index(record) if @make_index
-  end
 
-  def each
-    @rows.each do |row|
-      yield row
+    def each
+      @rows.each do |row|
+        yield row
+      end
     end
-  end
 
-  def size
-    length
-  end
+    def size
+      length
+    end
 
-  def length
-    @rows.length
-  end
+    def length
+      @rows.length
+    end
 
-  def [](index)
-    @rows[index]
-  end
+    def [](index)
+      @rows[index]
+    end
 
-  def column(column_name)
-    arr = []
-    @rows.each do |row|
-      arr << row[column_name]
+    def column(column_name)
+      arr = []
+      @rows.each do |row|
+        arr << row[column_name]
+      end
+      arr
     end
-    arr
-  end
 
-  def group_by_metric
-    @metric_index.to_a
-  end
+    def group_by_metric
+      @metric_index.to_a
+    end
 
-  def rows_with(conditions)
-    if optimized_conditions?(conditions)
-      optimized_select(conditions)
-    else
-      slow_select(conditions)
+    def rows_with(conditions)
+      if optimized_conditions?(conditions)
+        optimized_select(conditions)
+      else
+        slow_select(conditions)
+      end
     end
-  end
 
-  def delete_at(index)
-    @rows.delete_at(index)
-  end
+    def delete_at(index)
+      @rows.delete_at(index)
+    end
 
-  def to_a
-    @rows
-  end
+    def to_a
+      @rows
+    end
 
-  def map
-    new_table = Table.new(:column_names => @columns)
-    @rows.map do |row|
-      new_table << (yield row)
+    def map
+      new_table = MetricFu::Table.new(:column_names => @columns)
+      @rows.map do |row|
+        new_table << (yield row)
+      end
+      new_table
     end
-    new_table
-  end
 
-  private
+    private
 
-  def optimized_conditions?(conditions)
-    conditions.keys.length == 1 && conditions.keys.first.to_sym == :metric
-  end
+    def optimized_conditions?(conditions)
+      conditions.keys.length == 1 && conditions.keys.first.to_sym == :metric
+    end
 
-  def optimized_select(conditions)
-    metric = (conditions['metric'] || conditions[:metric]).to_s
-    @metric_index[metric].to_a.clone
-  end
+    def optimized_select(conditions)
+      metric = (conditions['metric'] || conditions[:metric]).to_s
+      @metric_index[metric].to_a.clone
+    end
 
-  def slow_select(conditions)
-    @rows.select do |row|
-      conditions.all? do |key, value|
-        row.has_key?(key.to_s) && row[key.to_s] == value
+    def slow_select(conditions)
+      @rows.select do |row|
+        conditions.all? do |key, value|
+          row.has_key?(key.to_s) && row[key.to_s] == value
+        end
       end
     end
-  end
 
-  def updated_key_index(record)
-    if record.has_key?('metric')
-      @metric_index[record.metric] ||= Table.new(:column_names => @columns, :make_index => false)
-      @metric_index[record.metric] << record
+    def updated_key_index(record)
+      if record.has_key?('metric')
+        @metric_index[record.metric] ||= MetricFu::Table.new(:column_names => @columns, :make_index => false)
+        @metric_index[record.metric] << record
+      end
     end
-  end
 
+  end
 end