metric_fu 4.4.0 → 4.4.1

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

@@ -23,7 +23,6 @@ module MetricFu
 
     def activate
       activate_library('rails_best_practices')
-      activate_library('metric_fu/sexp_ext')
       super
     end
 

data/lib/metric_fu/metrics/rcov/rcov_hotspot.rb

@@ -1,5 +1,4 @@
-class RcovHotspot < MetricFu::Hotspot
-  include MetricFu::HotspotScoringStrategies
+class MetricFu::RcovHotspot < MetricFu::Hotspot
 
   COLUMNS = %w{percentage_uncovered}
 
@@ -12,15 +11,15 @@ class RcovHotspot < MetricFu::Hotspot
   end
 
   def map(row)
-    row.percentage_uncovered
+    :percentage_uncovered
   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 RcovHotspot < MetricFu::Hotspot
     "#{"average " if occurences > 1}uncovered code is %.1f%" % average_code_uncoverage
   end
 
-  # TODO determine if no-op in pre-factored
-  # code was intentional
-  def present_group_details(group)
-
-  end
-
 end

data/lib/metric_fu/metrics/reek/reek_hotspot.rb

@@ -1,83 +1,12 @@
 # coding: utf-8
 
 class ReekHotspot < MetricFu::Hotspot
-  include MetricFu::HotspotScoringStrategies
-
-  REEK_ISSUE_INFO = {
-    'Uncommunicative Name' =>
-      {'link' => 'http://wiki.github.com/kevinrutherford/reek/uncommunicative-name',
-       'info' => 'An Uncommunicative Name is a name that doesn’t communicate its intent well enough.'},
-    'Class Variable' =>
-      {'link' => 'http://wiki.github.com/kevinrutherford/reek/class-variable',
-       'info' => 'Class variables form part of the global runtime state, and as such make it ' +
-                 'easy for one part of the system to accidentally or inadvertently depend on ' +
-                 'another part of the system.'},
-    'Duplication' =>
-      {'link' =>'http://wiki.github.com/kevinrutherford/reek/duplication',
-       'info' => 'Duplication occurs when two fragments of code look nearly identical, or when ' +
-                 'two fragments of code have nearly identical effects at some conceptual level.'},
-    'Low Cohesion' =>
-      {'link' => 'http://en.wikipedia.org/wiki/Cohesion_(computer_science)',
-       'info' => 'Low cohesion is associated with undesirable traits such as being difficult to ' +
-                 'maintain, difficult to test, difficult to reuse, and even difficult to understand.'},
-    'Nested Iterators' =>
-      {'link' =>'http://wiki.github.com/kevinrutherford/reek/nested-iterators',
-       'info' => 'Nested Iterator occurs when a block contains another block.'},
-    'Control Couple' =>
-      {'link' =>'http://wiki.github.com/kevinrutherford/reek/control-couple',
-       'info' => 'Control coupling occurs when a method or block checks the value of a parameter in ' +
-                 'order to decide which execution path to take. The offending parameter is often called a “Control Couple”.'},
-    'Irresponsible Module' =>
-      {'link' =>'http://wiki.github.com/kevinrutherford/reek/irresponsible-module',
-       'info' => 'Classes and modules are the units of reuse and release. It is therefore considered ' +
-                 'good practice to annotate every class and module with a brief comment outlining its responsibilities.'},
-    'Long Parameter List' =>
-      {'link' =>'http://wiki.github.com/kevinrutherford/reek/long-parameter-list',
-       'info' => 'A Long Parameter List occurs when a method has more than one or two parameters, ' +
-                 'or when a method yields more than one or two objects to an associated block.'},
-    'Data Clump' =>
-      {'link' =>'http://wiki.github.com/kevinrutherford/reek/data-clump',
-       'info' => 'In general, a Data Clump occurs when the same two or three items frequently appear ' +
-                 'together in classes and parameter lists, or when a group of instance variable names ' +
-                 'start or end with similar substrings.'},
-    'Simulated Polymorphism' =>
-      {'link' =>'http://wiki.github.com/kevinrutherford/reek/simulated-polymorphism',
-       'info' => 'Simulated Polymorphism occurs when, code uses a case statement (especially on a ' +
-                 'type field) or code uses instance_of?, kind_of?, is_a?, or === to decide what code to execute'},
-    'Large Class' =>
-      {'link' =>'http://wiki.github.com/kevinrutherford/reek/large-class',
-       'info' => 'A Large Class is a class or module that has a large number of instance variables, ' +
-                 'methods or lines of code in any one piece of its specification.'},
-    'Long Method' =>
-      {'link' =>'http://wiki.github.com/kevinrutherford/reek/long-method',
-       'info' => 'Long methods can be hard to read and understand. They often are harder to test and ' +
-                 'maintain as well, which can lead to buggier code.'},
-    'Feature Envy' =>
-      {'link' =>'http://wiki.github.com/kevinrutherford/reek/feature-envy',
-       'info' => 'Feature Envy occurs when a code fragment references another object more often than ' +
-                 'it references itself, or when several clients do the same series of manipulations ' +
-                 'on a particular type of object.'},
-    'Utility Function' =>
-      {'link' =>'http://wiki.github.com/kevinrutherford/reek/utility-function',
-       'info' => 'A Utility Function is any instance method that has no dependency on the state of the ' +
-                 'instance. It reduces the code’s ability to communicate intent. Code that “belongs” on ' +
-                 'one class but which is located in another can be hard to find.'},
-    'Attribute' =>
-      {'link' => 'http://wiki.github.com/kevinrutherford/reek/attribute',
-       'info' => 'A class that publishes a getter or setter for an instance variable invites client ' +
-                 'classes to become too intimate with its inner workings, and in particular with its ' +
-                 'representation of state.'}
-  }
 
   # Note that in practice, the prefix reek__ is appended to each one
   # This was a partially implemented idea to avoid column name collisions
   # but it is only done in the ReekHotspot
   COLUMNS = %w{type_name message value value_description comparable_message}
 
-  def self.issue_link(issue)
-    REEK_ISSUE_INFO[issue]
-  end
-
   def columns
     COLUMNS.map{|column| "#{name}__#{column}"}
   end
@@ -86,16 +15,16 @@ class ReekHotspot < MetricFu::Hotspot
     :reek
   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)
@@ -131,16 +60,6 @@ class ReekHotspot < MetricFu::Hotspot
     occurences = group.size
     "found #{occurences} code smells"
   end
-  def present_group_details(group)
-    occurences = group.size
-    message = "found #{occurences} code smells<br/>"
-    group.each do |item|
-      type    = item.data["reek__type_name"]
-      reek_message = item.data["reek__message"]
-      message << "* #{type}: #{reek_message}<br/>"
-    end
-    message
-  end
 
   private
 

data/lib/metric_fu/metrics/roodi/roodi_hotspot.rb

@@ -1,5 +1,4 @@
-class RoodiHotspot < MetricFu::Hotspot
-  include MetricFu::HotspotScoringStrategies
+class MetricFu::RoodiHotspot < MetricFu::Hotspot
 
   COLUMNS = %w{problems}
 
@@ -11,16 +10,16 @@ class RoodiHotspot < MetricFu::Hotspot
     :roodi
   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)
@@ -39,14 +38,4 @@ class RoodiHotspot < MetricFu::Hotspot
     "found #{occurences} design problems"
   end
 
-  def present_group_details(group)
-    occurences = group.size
-    message = "found #{occurences} design problems<br/>"
-    group.each do |item|
-      problem    = item.data["problems"]
-      message << "* #{problem}<br/>"
-    end
-    message
-  end
-
 end

data/lib/metric_fu/metrics/saikuro/saikuro.rb

@@ -20,11 +20,6 @@ module MetricFu
       `#{command}`
     end
 
-    def format_directories
-      dirs = options[:input_directory].join(" | ")
-      "\"#{dirs}\""
-    end
-
     def analyze
       @files = sort_files(assemble_files)
       @classes = sort_classes(assemble_classes(@files))

data/lib/metric_fu/metrics/saikuro/saikuro_hotspot.rb

@@ -1,5 +1,4 @@
-class SaikuroHotspot < MetricFu::Hotspot
-  include MetricFu::HotspotScoringStrategies
+class MetricFu::SaikuroHotspot < MetricFu::Hotspot
 
   COLUMNS = %w{lines complexity}
 
@@ -11,16 +10,16 @@ class SaikuroHotspot < MetricFu::Hotspot
     :saikuro
   end
 
-  def map(row)
-    row.complexity
+  def map_strategy
+    :complexity
   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)
@@ -51,10 +50,4 @@ class SaikuroHotspot < MetricFu::Hotspot
     "#{"average " if occurences > 1}complexity is %.1f" % complexity
   end
 
-  def present_group_details(group)
-    occurences = group.size
-    complexity = get_mean(group.column("complexity"))
-    "#{"average " if occurences > 1}complexity is %.1f" % complexity
-  end
-
 end

data/lib/metric_fu/metrics/stats/stats_hotspot.rb

@@ -1,4 +1,4 @@
-class StatsHotspot < MetricFu::Hotspot
+class MetricFu::StatsHotspot < MetricFu::Hotspot
 
   COLUMNS = %w{stat_name stat_value}
 
@@ -10,16 +10,16 @@ class StatsHotspot < MetricFu::Hotspot
     :stats
   end
 
-  def map(row)
-    0
+  def map_strategy
+    :absent
   end
 
-  def reduce(scores)
-    0
+  def reduce_strategy
+    :absent
   end
 
-  def score(metric_ranking, item)
-    0
+  def score_strategy
+    :absent
   end
 
   def generate_records(data, table)

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

@@ -1,6 +1,7 @@
 require 'fileutils'
 require 'coderay'
 MetricFu.metrics_require { 'base_template' }
+MetricFu.lib_require { 'utility' }
 
 class AwesomeTemplate < MetricFu::Template
 
@@ -44,7 +45,7 @@ class AwesomeTemplate < MetricFu::Template
   end
 
   def convert_ruby_to_html(ruby_text, line_number)
-    tokens = CodeRay.scan(ruby_text, :ruby)
+    tokens = CodeRay.scan(MetricFu::Utility.clean_ascii_text(ruby_text), :ruby)
     options = { :css => :class, :style => :alpha }
     if line_number.to_i > 0
       options = options.merge({:line_numbers => :inline, :line_number_start => line_number.to_i })

data/lib/metric_fu/utility.rb

@@ -0,0 +1,20 @@
+module MetricFu
+  module Utility
+    module_function
+
+    # Removes non-ASCII characters
+    def clean_ascii_text(text)
+      if text.respond_to?(:encode)
+        # avoids invalid multi-byte escape error
+        ascii_text = text.encode( 'ASCII', invalid: :replace, undef: :replace, replace: '' )
+        # see http://www.ruby-forum.com/topic/183413
+        pattern = Regexp.new('[\x80-\xff]', nil, 'n')
+        ascii_text.gsub(pattern, '')
+      else
+        text
+      end
+    end
+
+
+  end
+end

data/lib/metric_fu/version.rb

@@ -1,3 +1,3 @@
 module MetricFu
-  VERSION = "4.4.0"
+  VERSION = "4.4.1"
 end

data/metric_fu.gemspec

@@ -28,14 +28,14 @@ Gem::Specification.new do |s|
   s.rdoc_options                = ["--main", "README.md"]
 
   # metric dependencies
-  s.add_runtime_dependency 'flay',                  ['~> 2.0.1']
+  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']
-  s.add_runtime_dependency 'reek',                  ['~> 1.3.1']
-  s.add_runtime_dependency 'cane',                  ['~> 2.5.2']
-  s.add_runtime_dependency 'rails_best_practices',  ['>= 1.14.1', '~> 1.14']
+  s.add_runtime_dependency 'flog',                  ['>= 4.1.1',  '~> 4.1']
+  s.add_runtime_dependency 'reek',                  ['>= 1.3.3',  '~> 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']
-  s.add_runtime_dependency 'metric_fu-roodi',       ['>= 2.2.1']
+  s.add_runtime_dependency 'roodi',                 ['~> 3.1']
   s.add_runtime_dependency 'code_metrics',          ['~> 0.1']
 
   # other dependencies

data/spec/metric_fu/configuration_spec.rb

@@ -10,8 +10,6 @@ describe MetricFu::Configuration do
       rcov.enabled = true
     end
     MetricFu.configure
-    mri_only_metrics = MetricFu.mri_only_metrics.reject {|metric| MetricFu::Metric.get_metric(metric).enabled }
-    MetricFu.stub(:mri_only_metrics).and_return(mri_only_metrics)
     MetricFu::Io::FileSystem.stub(:create_directories) # no need to create directories for the tests
     @config
   end
@@ -216,17 +214,11 @@ describe MetricFu::Configuration do
         @config.stub(:rails?).and_return(true)
         @config.reset
         MetricFu.configure
-        %w(stats rails_best_practices).each do |metric|
+        %w(rails_best_practices).each do |metric|
           load_metric metric
         end
       end
 
-      describe '#set_metrics ' do
-        it 'should set the metrics to include stats' do
-          MetricFu::Metric.enabled_metrics.map(&:name).should include(:stats)
-        end
-      end
-
       describe '#set_graphs ' do
         it 'should set the graphs to include rails_best_practices' do
           expect(MetricFu::Metric.get_metric(:rails_best_practices).has_graph?).to be_true
@@ -239,13 +231,6 @@ describe MetricFu::Configuration do
                   should == ['app','lib']
         end
       end
-      it 'should set @stats to {}' do
-        load_metric 'stats'
-        expect(MetricFu::Metric.get_metric(:stats).run_options).to eq({
-          :additional_test_directories=>[{:glob_pattern=>"./spec/**/*_spec.rb", :file_pattern=>"spec"}],
-          :additional_app_directories=>[{:glob_pattern=>"./engines/**/*.rb", :file_pattern=>""}]
-        })
-      end
 
       it 'should set @rails_best_practices to {}' do
         load_metric 'rails_best_practices'
@@ -257,15 +242,11 @@ describe MetricFu::Configuration do
       before(:each) do
         get_new_config
         @config.stub(:rails?).and_return(false)
-        %w(stats rails_best_practices).each do |metric|
+        %w(rails_best_practices).each do |metric|
           load_metric metric
         end
       end
 
-      it 'should set the available metrics' do
-        MetricFu::Metric.enabled_metrics.map(&:name).should =~ [:churn, :flog, :flay, :reek, :roodi, :rcov, :hotspots, :saikuro, :cane, :stats] - MetricFu.mri_only_metrics
-      end
-
       it 'should set the registered code_dirs to ["lib"]' do
         directory('code_dirs').should == ['lib']
       end

data/spec/metric_fu/metrics/flog/flog_grapher_spec.rb

@@ -47,7 +47,7 @@ describe MetricFu::FlogGrapher do
 
     context "when metrics were not generated" do
       before(:each) do
-        @metrics = YAML::load(File.open("#{resources_path}/yml/metric_missing.yml"))
+        @metrics = metric_data('metric_missing.yml')
         @date = "1/2"
       end
 
@@ -69,7 +69,7 @@ describe MetricFu::FlogGrapher do
 
     context "when metrics have been generated" do
       before(:each) do
-        @metrics = YAML::load(File.open("#{resources_path}/yml/20090630.yml"))
+        @metrics = metric_data('20090630.yml')
         @date = "1/2"
       end
 

data/spec/metric_fu/metrics/generator_spec.rb

@@ -83,20 +83,6 @@ describe MetricFu::Generator do
     end
   end
 
-  describe 'ConcreteClass#generate_result' do
-    it 'should create a new instance of ConcreteClass' do
-      ConcreteClass.should_receive(:new).and_return(@concrete_class)
-      @concrete_class.should_receive(:generate_result).and_return(true)
-      ConcreteClass.generate_result
-    end
-
-    it 'should call #generate_result on the new ConcreteClass' do
-      ConcreteClass.should_receive(:new).and_return(@concrete_class)
-      @concrete_class.should_receive(:generate_result).and_return(true)
-      ConcreteClass.generate_result
-    end
-  end
-
   describe '@concrete_class should have hook methods for '\
            +'[before|after]_[emit|analyze|to_h]' do