indirect-metric_fu 0.8.2 → 0.9.0

data/spec/{flay_reporter_spec.rb → flay_spec.rb}

@@ -1,12 +1,19 @@
 require File.dirname(__FILE__) + '/spec_helper.rb'
 
-describe MetricFu::FlayReporter do
+describe MetricFu::Flay do
 
   describe "generate_html" do
     it "should create a new Generator and call generate_report on it" do
-      @generator = MetricFu::FlayReporter.new('other_dir')
+      @generator = MetricFu::Flay.new('other_dir')
       @generator.should_receive(:`).and_return("Matches found in :call (mass = 55)\n\tlib/metric_fu/flog_reporter.rb:2\n\tlib/metric_fu/flog_reporter.rb:3")
       @generator.generate_html
     end
   end
-end
+
+  describe "template_name" do
+    it "should return the class name in lowercase" do
+      flay = MetricFu::Flay.new('base_dir')
+      flay.template_name.should == 'flay'
+    end
+  end
+end

data/spec/flog_spec.rb

@@ -0,0 +1,208 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+include MetricFu::Flog
+
+describe "Flog::Base" do
+  before do
+    @alpha_only_method = <<-AOM
+    Total flog = 13.6283678106927
+
+    ErrorMailer#errormail: (12.5)
+        12.0: assignment
+         1.2: []
+         1.2: now
+         1.2: content_type
+AOM
+
+    @method_that_has_digits = <<-MTHD
+    Total flog = 7.08378429936994
+
+    NoImmunizationReason#to_c32: (7.1)
+         3.0: code
+         2.3: branch
+         1.4: templateId
+         1.2: act
+         1.1: entryRelationship
+MTHD
+
+    @bang_method = <<-BM
+    Total flog = 7.08378429936994
+
+    NoImmunizationReason#to_c32!: (7.1)
+         3.0: code
+         2.3: branch
+         1.4: templateId
+         1.2: act
+         1.1: entryRelationship
+BM
+
+    @invalid_method = <<-IM
+    Total flog = 7.08378429936994
+
+         3.0: code
+         2.3: branch
+         1.4: templateId
+         1.2: act
+         1.1: entryRelationship
+IM
+
+    @assignment_method = <<-MTHD
+    Total Flog = 21.6 (5.4 +/- 3.3 flog / method)
+
+    ActivityReport#existing_measure_attributes=: (8.5)
+         4.1: assignment
+         1.8: id
+         1.6: to_s
+         1.4: []
+         1.4: activity_report_measures
+         1.2: each
+         1.2: branch
+    MTHD
+
+    @class_methods_grouped_together = <<-MTHD
+    Total Flog = 61.8 (7.7 +/- 95.3 flog / method)
+
+    User#none: (32.8)
+         7.2: include
+         3.6: validates_length_of
+         3.6: validates_format_of
+         2.4: validates_presence_of
+         2.4: validates_uniqueness_of
+         1.4: bad_login_message
+         1.4: name_regex
+         1.4: bad_email_message
+         1.4: bad_name_message
+         1.4: login_regex
+         1.4: email_regex
+         1.2: private
+         1.2: has_and_belongs_to_many
+         1.2: before_create
+         1.2: attr_accessible
+         0.4: lit_fixnum
+    MTHD
+  end
+
+  it "should be able to parse class_methods_grouped_together" do
+    page = Base.parse(@class_methods_grouped_together)
+    page.should_not be_nil
+    page.score.should == 61.8
+    page.scanned_methods.size.should == 1
+    sm = page.scanned_methods.first
+    sm.name.should == 'User#none'
+    sm.score.should == 32.8
+
+    sm.operators.size.should == 16
+    sm.operators.first.score.should == 7.2
+    sm.operators.first.operator.should == "include"
+
+    sm.operators.last.score.should == 0.4
+    sm.operators.last.operator.should == "lit_fixnum"
+  end
+
+  it "should be able to parse an assignment method" do
+    page = Base.parse(@assignment_method)
+    page.should_not be_nil
+    page.score.should == 21.6
+    page.scanned_methods.size.should == 1
+    sm = page.scanned_methods.first
+    sm.name.should == 'ActivityReport#existing_measure_attributes='
+    sm.score.should == 8.5
+  end
+
+  it "should be able to parse an alpha only method" do
+    page = Base.parse(@alpha_only_method)
+    page.should_not be_nil
+    page.score.should == 13.6283678106927
+    page.scanned_methods.size.should == 1
+    sm = page.scanned_methods.first
+    sm.name.should == 'ErrorMailer#errormail'
+    sm.score.should == 12.5
+  end
+
+  it "should be able to parse method that has digits" do
+    page = Base.parse(@method_that_has_digits)
+    page.should_not be_nil
+    page.score.should == 7.08378429936994
+    page.scanned_methods.size.should == 1
+    sm = page.scanned_methods.first
+    sm.name.should == 'NoImmunizationReason#to_c32'
+    sm.score.should == 7.1
+  end
+
+  it "should be able to parse bang method" do
+    page = Base.parse(@bang_method)
+    page.should_not be_nil
+    page.score.should == 7.08378429936994
+    page.scanned_methods.size.should == 1
+    sm = page.scanned_methods.first
+    sm.name.should == 'NoImmunizationReason#to_c32!'
+    sm.score.should == 7.1
+  end
+
+  it "should return nil when parsing invalid method" do
+    page = Base.parse(@invalid_method)
+    page.should be_nil
+  end
+end
+
+IM = <<-IM
+    Total flog = 7.08378429936994
+
+         3.0: code
+         2.3: branch
+         1.4: templateId
+         1.2: act
+         1.1: entryRelationship
+IM
+describe MetricFu::Flog do
+
+  describe "generate_report" do
+    it "should generate reports" do
+      generator = Flog::Generator.new('other_dir')
+      generator.should_receive(:flog_results).and_return(['A', 'B'])
+      generator.should_receive(:save_html).at_least(3).times.and_return('')
+      generator.should_receive(:open).any_number_of_times.and_return(['Total Flog = 1273.9 (9.3 +/- 259.2 flog / method)', 'TokenCounter#list_tokens_per_line: (15.2)', '9.0: assignment'].join("\n"))
+      generator.generate_report
+    end
+
+    it "should be able to handle InvalidFlogs" do
+      generator = Flog::Generator.new('other_dir')
+      generator.should_receive(:flog_results).and_return(['A', 'B'])
+      generator.should_receive(:inline_css).any_number_of_times.and_return('')
+      generator.should_receive(:save_html).once
+      generator.should_receive(:open).any_number_of_times.and_return(IM)
+      generator.generate_report
+    end
+  end
+
+  describe "template_name" do
+    it "should return the class name in lowercase" do
+      flog = Flog::Generator.new('base_dir')
+      Flog::Generator.template_name.should == 'flog'
+    end
+  end
+end
+
+describe MetricFu::Flog::Page do
+
+  describe "average_score" do
+    it "should calculate the average score" do
+      page = Page.new(10)
+      page.should_receive(:scanned_methods).any_number_of_times.and_return([ScannedMethod.new(:test, 10), ScannedMethod.new(:test, 20)])
+      page.average_score.should == 15
+    end
+
+    it "should be able to handle divide by zero" do
+      page = Page.new(10)
+      page.should_receive(:scanned_methods).any_number_of_times.and_return([])
+      page.average_score.should == 0
+    end
+  end
+
+  describe "highest_score" do
+    it "should calculate the average score" do
+      page = Page.new(10)
+      page.should_receive(:scanned_methods).any_number_of_times.and_return([ScannedMethod.new(:test, 10), ScannedMethod.new(:test, 20)])
+      page.highest_score.should == 20
+    end
+  end
+end

data/spec/md5_tracker_spec.rb

@@ -1,6 +1,4 @@
-require 'spec'
-require File.join(File.dirname(__FILE__), '../lib/metric_fu/md5_tracker')
-include MetricFu
+require File.dirname(__FILE__) + '/spec_helper.rb'
 
 describe MetricFu::MD5Tracker do
   before do

data/spec/reek_spec.rb

@@ -0,0 +1,26 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+REEK_RESULT = %("lib/metric_fu/base.rb" -- 5 warnings:
+[Utility Function] #configuration doesn't depend on instance state
+[Utility Function] #open_in_browser? doesn't depend on instance state
+[Long Method] Configuration#reset has approx 6 statements
+[Utility Function] Generator#cycle doesn't depend on instance state
+[Utility Function] Generator#link_to_filename doesn't depend on instance state)
+
+describe MetricFu::Reek do
+
+  describe "generate_html" do
+    it "should create a new Generator and call generate_report on it" do
+      @generator = MetricFu::Reek.new('other_dir')
+      @generator.should_receive(:`).and_return(REEK_RESULT)
+      @generator.generate_html
+    end
+  end
+
+  describe "template_name" do
+    it "should return the class name in lowercase" do
+      flay = MetricFu::Reek.new('base_dir')
+      flay.template_name.should == 'reek'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,7 +1,11 @@
+require 'rubygems'
 require 'spec'
 require 'date'
 
-require File.dirname(__FILE__) + '/../lib/metric_fu/base'
-require File.dirname(__FILE__) + '/../lib/metric_fu/flay_reporter'
-require File.dirname(__FILE__) + '/../lib/metric_fu/churn'
+require File.join(File.dirname(__FILE__), '/../lib/metric_fu/base')
+require File.join(File.dirname(__FILE__), '/../lib/metric_fu/flay')
+require File.join(File.dirname(__FILE__), '/../lib/metric_fu/flog')
+require File.join(File.dirname(__FILE__), '/../lib/metric_fu/md5_tracker')
+require File.join(File.dirname(__FILE__), '/../lib/metric_fu/churn')
+require File.join(File.dirname(__FILE__), '/../lib/metric_fu/reek')
 include MetricFu

metadata

@@ -1,19 +1,29 @@
 --- !ruby/object:Gem::Specification 
 name: indirect-metric_fu
 version: !ruby/object:Gem::Version 
-  version: 0.8.2
+  version: 0.9.0
 platform: ruby
 authors: 
 - Jake Scruggs
 - Sean Soper
 - Andre Arko
+- Petrik de Heus
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2008-10-27 00:00:00 -07:00
+date: 2009-02-05 00:00:00 -08:00
 default_executable: 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: flay
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: 
 - !ruby/object:Gem::Dependency 
   name: flog
   version_requirement: 
@@ -28,12 +38,21 @@ dependencies:
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version 
         version: 0.8.1
     version: 
 - !ruby/object:Gem::Dependency 
-  name: flay
+  name: railroad
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.5.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: reek
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -42,7 +61,7 @@ dependencies:
         version: 0.0.0
     version: 
 - !ruby/object:Gem::Dependency 
-  name: diff-lcs
+  name: roodi
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -50,7 +69,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.0.0
     version: 
-description: Code metrics from Flog, Flay, RCov, Saikuro, Churn, and Rails' stats task
+description: Code metrics from Flog, Flay, RCov, Saikuro, Churn, Reek, Roodi and Rails' stats task
 email: jake.scruggs@gmail.com
 executables: []
 
@@ -58,6 +77,7 @@ extensions: []
 
 extra_rdoc_files: 
 - HISTORY
+- Manifest.txt
 - README
 files: 
 - README
@@ -67,13 +87,10 @@ files:
 - Rakefile
 - lib/metric_fu/base.rb
 - lib/metric_fu/churn.rb
-- lib/metric_fu/flay_reporter.rb
-- lib/metric_fu/flog_reporter/base.rb
-- lib/metric_fu/flog_reporter/generator.rb
-- lib/metric_fu/flog_reporter/operator.rb
-- lib/metric_fu/flog_reporter/page.rb
-- lib/metric_fu/flog_reporter/scanned_method.rb
-- lib/metric_fu/flog_reporter.rb
+- lib/metric_fu/flay.rb
+- lib/metric_fu/flog.rb
+- lib/metric_fu/reek.rb
+- lib/metric_fu/roodi.rb
 - lib/metric_fu/md5_tracker.rb
 - lib/metric_fu/saikuro/saikuro.rb
 - lib/metric_fu.rb
@@ -83,15 +100,19 @@ files:
 - lib/tasks/flay.rake
 - lib/tasks/flog.rake
 - lib/tasks/metric_fu.rake
+- lib/tasks/railroad.rake
+- lib/tasks/reek.rake
+- lib/tasks/roodi.rake
 - lib/tasks/saikuro.rake
 - lib/tasks/stats.rake
-- lib/templates/churn.css
 - lib/templates/churn.html.erb
-- lib/templates/flay.css
+- lib/templates/default.css
 - lib/templates/flay.html.erb
-- lib/templates/flog.css
 - lib/templates/flog.html.erb
 - lib/templates/flog_page.html.erb
+- lib/templates/reek.html.erb
+- lib/templates/roodi.html.erb
+- Manifest.txt
 has_rdoc: true
 homepage: http://metric-fu.rubyforge.org/
 post_install_message: 
@@ -122,7 +143,10 @@ summary: A fistful of code metrics
 test_files: 
 - spec/base_spec.rb
 - spec/churn_spec.rb
-- spec/flay_reporter_spec.rb
-- spec/flog_reporter/base_spec.rb
+- spec/config_spec.rb
+- spec/flay_spec.rb
+- spec/flog_spec.rb
 - spec/md5_tracker_spec.rb
+- spec/reek_spec.rb
+- spec/roodi_spec.rb
 - spec/spec_helper.rb

data/lib/metric_fu/flay_reporter.rb

@@ -1,17 +0,0 @@
-require 'erb'
-
-module MetricFu
-  class FlayReporter < Base::Generator
-
-    def analyze
-      files_to_flay = MetricFu::CODE_DIRS.map{|dir| Dir[File.join(dir, "**/*.rb")] }
-      output = `flay #{files_to_flay.join(" ")}`
-      @matches = output.chomp.split("\n\n").map{|m| m.split("\n  ") }
-    end
-
-    def template_name
-      'flay'
-    end
-
-  end
-end

data/lib/metric_fu/flog_reporter/base.rb

@@ -1,49 +0,0 @@
-module MetricFu::FlogReporter
-
-  SCORE_FORMAT = "%0.2f"
-
-  class InvalidFlog < RuntimeError
-  end
-
-  class Base
-    MODULE_NAME = "([A-Za-z]+)+"
-    METHOD_NAME = "#([a-z0-9]+_?)+\\??\\!?"
-    SCORE = "\\d+\\.\\d+"
-
-    METHOD_NAME_RE = Regexp.new("#{MODULE_NAME}#{METHOD_NAME}")
-    SCORE_RE = Regexp.new(SCORE)
-
-    METHOD_LINE_RE = Regexp.new("#{MODULE_NAME}#{METHOD_NAME}:\\s\\(#{SCORE}\\)")
-    OPERATOR_LINE_RE = Regexp.new("\\s+(#{SCORE}):\\s(.*)$")
-
-    class << self
-      def cycle(first_value, second_value, iteration)
-        return first_value if iteration % 2 == 0
-        return second_value
-      end
-
-      def parse(text)
-        score = text[/\w+ = (\d+\.\d+)/, 1]
-        return nil unless score
-        page = Page.new(score)
-
-        text.each_line do |method_line|
-          if METHOD_LINE_RE =~ method_line and
-             method_name = method_line[METHOD_NAME_RE] and
-             score = method_line[SCORE_RE]
-             page.scanned_methods << ScannedMethod.new(method_name, score)
-          end
-
-          if OPERATOR_LINE_RE =~ method_line and
-             operator = method_line[OPERATOR_LINE_RE, 2] and
-             score = method_line[SCORE_RE]
-             raise InvalidFlog if page.scanned_methods.empty?
-             page.scanned_methods.last.operators << Operator.new(score, operator)
-          end
-        end
-
-        page
-      end
-    end
-  end
-end