metric_fu 1.1.5 → 1.1.6

data/lib/base/configuration.rb

@@ -130,6 +130,8 @@ module MetricFu
                                    "--profile",
                                    "--rails",
                                    "--exclude /gems/,/Library/,/usr/,spec"]}
+
+      @file_globs_to_ignore = []
                                    
       @graph_theme = { :colors => %w(orange purple green white red blue pink yellow),
                        :marker_color => 'blue',

data/lib/base/generator.rb

@@ -97,6 +97,13 @@ module MetricFu
       self.class.metric_directory
     end
 
+    def remove_excluded_files(paths, globs_to_remove = MetricFu.file_globs_to_ignore)
+      files_to_remove = []
+      globs_to_remove.each do |glob|
+        files_to_remove.concat(Dir[glob])
+      end
+      paths - files_to_remove
+    end
    
     # Defines some hook methods for the concrete classes to hook into.
     %w[emit analyze].each do |meth|

data/lib/generators/flay.rb

@@ -9,7 +9,8 @@ module MetricFu
 
     def emit
       files_to_flay = MetricFu.flay[:dirs_to_flay].map{|dir| Dir[File.join(dir, "**/*.rb")] }
-      @output = `flay #{files_to_flay.join(" ")}`
+      files = remove_excluded_files(files_to_flay.flatten)
+      @output = `flay #{files.join(" ")}`
     end
 
     def analyze

data/lib/generators/flog.rb

@@ -1,3 +1,5 @@
+require 'pathname'
+
 module MetricFu
 
   class Flog < Generator
@@ -15,11 +17,17 @@ module MetricFu
     def emit
       metric_dir = MetricFu::Flog.metric_directory
       MetricFu.flog[:dirs_to_flog].each do |directory|
-        Dir.glob("#{directory}/**/*.rb").each do |filename|
+        directory = "." if directory=='./'
+        files = Dir.glob("#{directory}/**/*.rb")
+        files = remove_excluded_files(files)
+        files.each do |filename|
           output_dir = "#{metric_dir}/#{filename.split("/")[0..-2].join("/")}"
           mkdir_p(output_dir, :verbose => false) unless File.directory?(output_dir)
-          if MetricFu::MD5Tracker.file_changed?(filename, metric_dir)
-            `flog -ad #{filename} > #{metric_dir}/#{filename.split('.')[0]}.txt`
+          pathname         = Pathname.new(filename)
+          if MetricFu::MD5Tracker.file_changed?(filename, metric_dir) 
+		base_name = pathname.basename.to_s.gsub(/\..*$/,'.txt')
+                editted_filename = File.join(pathname.dirname.to_s, base_name)
+         `flog -ad #{filename} > #{metric_dir}/#{editted_filename}`
           end
         end
       end
@@ -54,7 +62,10 @@ module MetricFu
         page = parse(open(path, "r") { |f| f.read })
         if page
           page.path = path.sub(metric_directory, "").sub(".txt", ".rb") 
-          @pages << page
+          #don't include old cached flog results for files that no longer exist.
+	  if is_file_current?(page.path.to_s)
+            @pages << page
+          end
         end
       end
     end
@@ -69,7 +80,23 @@ module MetricFu
     end
     
     private
-    
+
+    def is_file_current?(pathname)
+      pathname        = pathname.gsub(/^\//,'')
+      local_pathname  = "./#{pathname}"
+      exists = false
+
+      MetricFu.flog[:dirs_to_flog].each do |directory|
+      	directory = "." if directory=='./'
+        files = Dir.glob("#{directory}/**/*.rb")
+        if files.include?(pathname) || files.include?(local_pathname)
+          exists = true
+          break
+        end
+      end
+      exists
+    end
+
     def average_score(total_flog_score, number_of_methods)
       return 0 if total_flog_score == 0
       round_to_tenths(total_flog_score/number_of_methods)

data/lib/generators/reek.rb

@@ -10,7 +10,34 @@ module MetricFu
 
     def emit
       files_to_reek = MetricFu.reek[:dirs_to_reek].map{|dir| Dir[File.join(dir, "**/*.rb")] }
-      @output = `reek #{files_to_reek.join(" ")}`
+      files = remove_excluded_files(files_to_reek.flatten)
+      @output = `reek #{files.join(" ")}`
+      @output = massage_for_reek_12 if reek_12?
+    end
+
+    def reek_12?
+      return false if @output.length == 0
+      (@output =~ /^"/) != 0
+    end
+
+    def massage_for_reek_12
+      section_break = ''
+      @output.split("\n").map do |line|
+        case line
+        when /^  /
+          "#{line.gsub(/^  /, '')}\n"
+        else
+          parts = line.split(" -- ")
+          if parts[1].nil?
+            "#{line}\n"
+          else
+            warnings = parts[1].gsub(/ \(.*\):/, ':')
+            result = "#{section_break}\"#{parts[0]}\" -- #{warnings}\n"
+            section_break = "\n"
+            result
+          end
+        end
+      end.join
     end
 
     def analyze

data/lib/generators/roodi.rb

@@ -9,7 +9,8 @@ module MetricFu
     
     def emit
       files_to_analyze = MetricFu.roodi[:dirs_to_roodi].map{|dir| Dir[File.join(dir, "**/*.rb")] }
-      @output = `roodi #{files_to_analyze.join(" ")}`
+      files = remove_excluded_files(files_to_analyze.flatten)
+      @output = `roodi #{files.join(" ")}`
     end
 
     def analyze

data/spec/base/generator_spec.rb

@@ -2,6 +2,8 @@ require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
 
 describe MetricFu::Generator do
 
+  include Construct::Helpers
+
   MetricFu::Configuration.run do |config|
   end
 
@@ -177,5 +179,66 @@ describe MetricFu::Generator do
       ConcreteClass.new()
     end
   end
+
+  describe "path filter" do
+    
+    context "given a list of paths" do
+
+      before do
+        @paths = %w(lib/fake/fake.rb
+                  lib/this/dan_file.rb
+                  lib/this/ben_file.rb
+                  lib/this/avdi_file.rb
+                  basic.rb
+                  lib/bad/one.rb
+                  lib/bad/two.rb
+                  lib/bad/three.rb
+                  lib/worse/four.rb)
+        @container = create_construct 
+        @paths.each do |path|
+          @container.file(path)
+        end
+        @old_dir = Dir.pwd
+        Dir.chdir(@container)
+      end
+      
+      after do
+        Dir.chdir(@old_dir)
+        @container.destroy!
+      end
+
+      it "should return entire pathlist given no exclude pattens" do
+        files = @concrete_class.remove_excluded_files(@paths)
+        files.should be == @paths
+      end
+
+      it "should filter filename at root level" do
+        files = @concrete_class.remove_excluded_files(@paths, ['basic.rb'])
+        files.should_not include('basic.rb')
+      end
+
+      it "should remove files that are two levels deep" do
+        files = @concrete_class.remove_excluded_files(@paths, ['**/fake.rb'])
+        files.should_not include('lib/fake/fake.rb')
+      end
+
+      it "should remove files from an excluded directory" do
+        files = @concrete_class.remove_excluded_files(@paths, ['lib/bad/**'])
+        files.should_not include('lib/bad/one.rb')
+        files.should_not include('lib/bad/two.rb')
+        files.should_not include('lib/bad/three.rb')
+      end
+
+      it "should support shell alternation globs" do
+        files = @concrete_class.remove_excluded_files(@paths, ['lib/this/{ben,dan}_file.rb'])
+        files.should_not include('lib/this/dan_file.rb')
+        files.should_not include('lib/this/ben_file.rb')
+        files.should include('lib/this/avdi_file.rb')
+      end
+
+    end
+
+
+  end
   
 end

data/spec/generators/flog_spec.rb

@@ -184,6 +184,7 @@ describe Flog do
       File.stub!(:directory?).and_return(true)
       flog = MetricFu::Flog.new('base_dir')
       flog.should_receive(:open).and_return(@text)
+      flog.stub!(:is_file_current?).and_return(true)
       Dir.should_receive(:glob).and_return(["tmp/metric_fu/scratch/flog/app/controllers/user_controller.txt"])
       flog.analyze
       @flog_hash = flog.to_h
@@ -206,6 +207,24 @@ describe Flog do
     end
   end
   
+  describe "to_h function ignore files not current" do
+    before :each do
+      MetricFu::Configuration.run {}
+      File.stub!(:directory?).and_return(true)
+      flog = MetricFu::Flog.new('base_dir')
+      flog.should_receive(:open).and_return(@text)
+      flog.stub!(:is_file_current?).and_return(false)
+      Dir.should_receive(:glob).and_return(["tmp/metric_fu/scratch/flog/app/controllers/user_controller.txt"])
+      flog.analyze
+      @flog_hash = flog.to_h
+    end
+    
+    it "should put the total in the hash" do
+      @flog_hash.should == {:flog=>{:total=>0, :pages=>[], :average=>0}}
+    end
+  
+  end
+  
   describe "to_h function with zero total" do
     it "should not blow up" do
       MetricFu::Configuration.run {}

data/spec/generators/reek_spec.rb

@@ -58,3 +58,69 @@ NewlineController#some_method calls current_user.<< "new line\n" multiple times
   end
   
 end
+
+describe Reek do
+  before :each do
+    @reek = MetricFu::Reek.new
+    @lines11 = <<-HERE
+"app/controllers/activity_reports_controller.rb" -- 4 warnings:
+ActivityReportsController#authorize_user calls current_user.primary_site_ids multiple times (Duplication)
+ActivityReportsController#authorize_user calls params[id] multiple times (Duplication)
+ActivityReportsController#authorize_user calls params[primary_site_id] multiple times (Duplication)
+ActivityReportsController#authorize_user has approx 6 statements (Long Method)
+
+"app/controllers/application.rb" -- 1 warnings:
+ApplicationController#start_background_task/block/block is nested (Nested Iterators)
+
+"app/controllers/link_targets_controller.rb" -- 1 warnings:
+LinkTargetsController#authorize_user calls current_user.role multiple times (Duplication)
+
+"app/controllers/newline_controller.rb" -- 1 warnings:
+NewlineController#some_method calls current_user.<< "new line\n" multiple times (Duplication)
+      HERE
+    @lines12 = <<-HERE
+app/controllers/activity_reports_controller.rb -- 4 warnings (+3 masked):
+  ActivityReportsController#authorize_user calls current_user.primary_site_ids multiple times (Duplication)
+  ActivityReportsController#authorize_user calls params[id] multiple times (Duplication)
+  ActivityReportsController#authorize_user calls params[primary_site_id] multiple times (Duplication)
+  ActivityReportsController#authorize_user has approx 6 statements (Long Method)
+app/controllers/application.rb -- 1 warnings:
+  ApplicationController#start_background_task/block/block is nested (Nested Iterators)
+app/controllers/link_targets_controller.rb -- 1 warnings (+1 masked):
+  LinkTargetsController#authorize_user calls current_user.role multiple times (Duplication)
+app/controllers/newline_controller.rb -- 1 warnings:
+  NewlineController#some_method calls current_user.<< "new line\n" multiple times (Duplication)
+      HERE
+  end
+
+  context 'with Reek 1.1 output format' do
+    it 'reports 1.1 style when the output is empty' do
+      @reek.instance_variable_set(:@output, "")
+      @reek.should_not be_reek_12
+    end
+    it 'detects 1.1 format output' do
+      @reek.instance_variable_set(:@output, @lines11)
+      @reek.should_not be_reek_12
+    end
+
+    it 'massages empty output to be unchanged' do
+      @reek.instance_variable_set(:@output, "")
+      @reek.massage_for_reek_12.should be_empty
+    end
+  end
+
+  context 'with Reek 1.2 output format' do
+    before :each do
+      @reek = MetricFu::Reek.new
+    end
+    it 'detects 1.2 format output' do
+      @reek.instance_variable_set(:@output, @lines12)
+      @reek.should be_reek_12
+    end
+
+    it 'correctly massages 1.2 output' do
+      @reek.instance_variable_set(:@output, @lines12)
+      @reek.massage_for_reek_12.should == @lines11
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 require 'rubygems'
 require 'spec/autorun'
 require 'date'
+require 'construct'
 
 require File.join(File.dirname(__FILE__), '/../lib/metric_fu.rb')
 include MetricFu

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: metric_fu
 version: !ruby/object:Gem::Version 
-  version: 1.1.5
+  version: 1.1.6
 platform: ruby
 authors: 
 - Jake Scruggs
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-02 00:00:00 -06:00
+date: 2009-12-14 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -34,9 +34,9 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
-        version: 2.1.0
+        version: 2.2.0
     version: 
 - !ruby/object:Gem::Dependency 
   name: relevance-rcov