p8-metric_fu 0.8.4 → 0.8.4.1

data/Manifest.txt

@@ -0,0 +1,28 @@
+History.txt
+Manifest.txt
+metric_fu-0.7.gem
+metric_fu.gemspec
+MIT-LICENSE
+Rakefile
+README
+TODO.txt
+lib/metric_fu.rb
+lib/metric_fu/flog_reporter.rb
+lib/metric_fu/md5_tracker.rb
+lib/metric_fu/flog_reporter/base.rb
+lib/metric_fu/flog_reporter/flog_reporter.css
+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/saikuro/saikuro.rb
+lib/metric_fu/saikuro/SAIKURO_README
+lib/tasks/churn.rake
+lib/tasks/coverage.rake
+lib/tasks/flog.rake
+lib/tasks/metric_fu.rake
+lib/tasks/metric_fu.rb
+lib/tasks/saikuro.rake
+lib/tasks/stats.rake
+test/test_helper.rb
+test/test_md5_tracker.rb

data/lib/metric_fu/base.rb

@@ -1,3 +1,4 @@
+require 'erb'
 module MetricFu
 
   TEMPLATE_DIR = File.join(File.dirname(__FILE__), '..', 'templates')
@@ -11,12 +12,17 @@ module MetricFu
   end
 
   module Base
+    
+    ######################################################################
+    # Base class for report Generators
+    #
     class Generator
 
       def initialize(base_dir, options={})
         @base_dir = base_dir
       end
 
+      # generates a report for base_dir
       def self.generate_report(base_dir, options={})
         FileUtils.mkdir_p(base_dir, :verbose => false) unless File.directory?(base_dir)
         self.new(base_dir, options).generate_report
@@ -36,11 +42,22 @@ module MetricFu
         analyze
         html = ERB.new(File.read(template_file)).result(binding)
       end
+      
+      def template_name
+        self.class.to_s.split('::').last.downcase
+      end
 
       def template_file
         File.join(MetricFu::TEMPLATE_DIR, "#{template_name}.html.erb")
       end
-
+      
+      ########################
+      # Template methods
+      
+      def inline_css(css)
+	      open(File.join(MetricFu::TEMPLATE_DIR, css)) { |f| f.read }      
+      end
+      
       def link_to_filename(name, line = nil)
         filename = File.expand_path(name)
         if PLATFORM['darwin']
@@ -49,6 +66,11 @@ module MetricFu
           %{<a href="file://#{filename}">#{name}</a>}
         end
       end
+      
+      def cycle(first_value, second_value, iteration)
+        return first_value if iteration % 2 == 0
+        return second_value
+      end      
     end
   end
 end

data/lib/metric_fu/churn.rb

@@ -1,4 +1,11 @@
+CHURN_DIR = File.join(MetricFu::BASE_DIRECTORY, 'churn')
+    
 module MetricFu
+  
+  def generate_churn_report
+    MetricFu::Churn.generate_report(CHURN_DIR, defined?(MetricFu::CHURN_OPTIONS) ? MetricFu::CHURN_OPTIONS : {} )
+  end
+  
   class Churn < Base::Generator
 
     def initialize(base_dir, options={})
@@ -18,11 +25,6 @@ module MetricFu
       @changes = parse_log_for_changes.reject! {|file, change_count| change_count < @minimum_churn_count}
     end
 
-    # should be dynamically read from the class
-    def template_name
-      'churn'
-    end
-
     private
 
     def parse_log_for_changes

data/lib/metric_fu/{flay_reporter.rb → flay.rb}

@@ -1,7 +1,12 @@
-require 'erb'
+FLAY_DIR = File.join(MetricFu::BASE_DIRECTORY, 'flay')
 
 module MetricFu
-  class FlayReporter < Base::Generator
+  
+  def generate_flay_report
+    MetricFu::Flay.generate_report(FLAY_DIR)
+  end
+    
+  class Flay < Base::Generator
 
     def analyze
       files_to_flay = MetricFu::CODE_DIRS.map{|dir| Dir[File.join(dir, "**/*.rb")] }
@@ -9,9 +14,5 @@ module MetricFu
       @matches = output.chomp.split("\n\n").map{|m| m.split("\n  ") }
     end
 
-    def template_name
-      'flay'
-    end
-
   end
 end

data/lib/metric_fu/flog.rb

@@ -0,0 +1,139 @@
+FLOG_DIR = File.join(MetricFu::BASE_DIRECTORY, 'flog')
+
+module MetricFu
+  
+  def generate_flog_report
+    MetricFu::Flog::Generator.generate_report(FLOG_DIR)
+  end
+  
+  module Flog
+    class Generator < Base::Generator
+      def generate_report
+        pages = []
+        flog_results.each do |filename|
+          page = Base.parse(open(filename, "r") { |f| f.read })
+          if page
+            page.filename = filename
+            pages << page
+          end
+        end
+        generate_pages(pages)
+      end
+
+      def generate_pages(pages)
+        pages.each do |page|
+          unless MetricFu::MD5Tracker.file_already_counted?(page.filename)
+            generate_page(page)
+          end
+        end      
+        save_html(ERB.new(File.read(template_file)).result(binding))
+      end
+
+      def generate_page(page)
+        save_html(page.to_html, page.path)
+      end
+
+      def flog_results
+        Dir.glob("#{@base_dir}/**/*.txt")
+      end
+      
+      def template_name
+        "flog"
+      end
+    end
+
+    SCORE_FORMAT = "%0.2f"
+
+    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 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]
+               return if page.scanned_methods.empty?
+               page.scanned_methods.last.operators << Operator.new(score, operator)
+            end
+          end
+          page
+        end
+      end
+    end 
+  
+    class Page < MetricFu::Base::Generator
+      attr_accessor :filename, :score, :scanned_methods
+
+      def initialize(score, scanned_methods = [])
+        @score = score.to_f
+        @scanned_methods = scanned_methods
+      end
+
+      def path
+        File.basename(filename, ".txt") + '.html'
+      end
+
+      def to_html
+        ERB.new(File.read(template_file)).result(binding)
+      end
+
+      def average_score
+        return 0 if scanned_methods.length == 0
+        sum = 0
+        scanned_methods.each do |m|
+          sum += m.score
+        end
+        sum / scanned_methods.length
+      end
+
+      def highest_score
+        scanned_methods.inject(0) do |highest, m|
+          m.score > highest ? m.score : highest
+        end
+      end
+
+      def template_name
+        'flog_page'
+      end
+    end  
+  
+    class Operator
+      attr_accessor :score, :operator
+
+      def initialize(score, operator)
+        @score = score.to_f
+        @operator = operator
+      end
+    end  
+  
+    class ScannedMethod
+      attr_accessor :name, :score, :operators
+
+      def initialize(name, score, operators = [])
+        @name = name
+        @score = score.to_f
+        @operators = operators
+      end
+    end  
+  end
+end

data/lib/tasks/churn.rake

@@ -4,8 +4,7 @@ namespace :metrics do
 
   desc "Which files change the most"
   task :churn do
-    churn_dir = File.join(MetricFu::BASE_DIRECTORY, 'churn')
-    MetricFu::Churn.generate_report(churn_dir, defined?(MetricFu::CHURN_OPTIONS) ? MetricFu::CHURN_OPTIONS : {} )
-    system("open #{churn_dir}/index.html") if PLATFORM['darwin']
+    MetricFu.generate_churn_report
+    system("open #{CHURN_DIR}/index.html") if PLATFORM['darwin']
   end
 end

data/lib/tasks/coverage.rake

@@ -23,6 +23,8 @@ begin
         t.test_files = FileList['test/**/*_test.rb', 'spec/**/*_spec.rb']
         t.rcov_opts = ["--sort coverage", "--html", "--rails", "--exclude /gems/,/Library/"]
         t.output_dir = COVERAGE_DIR
+        # this line is a fix for Rails 2.1 relative loading issues
+        t.libs << 'test'
       end
       # TODO not sure what this improves but it requires the diff-lcs gem
       # http://github.com/indirect/metric_fu/commit/b9c1cf75f09d5b531b388cd01661eb16b5126968#diff-1

data/lib/tasks/flay.rake

@@ -1,9 +1,7 @@
-FLAY_DIR = File.join(MetricFu::BASE_DIRECTORY, 'flay')
-
 namespace :metrics do
   desc "Generate code duplication report with flay"
   task :flay do
-    MetricFu::FlayReporter.generate_report(FLAY_DIR)
+    MetricFu.generate_flay_report
     system("open #{FLAY_DIR}/index.html") if PLATFORM['darwin']
   end
 end

data/lib/tasks/flog.rake

@@ -1,5 +1,4 @@
 begin
-  FLOG_DIR = File.join(MetricFu::BASE_DIRECTORY, 'flog')
 
   def flog(output, directory)
     Dir.glob("#{directory}/**/*.rb").each do |filename|
@@ -41,18 +40,19 @@ begin
       desc "Generate a flog report from specified directories"
       task :custom do
         MetricFu::CODE_DIRS.each { |directory| flog(directory, directory) }
-        MetricFu::FlogReporter::Generator.generate_report(FLOG_DIR)
+        MetricFu.generate_flog_report
+        system("open #{FLOG_DIR}/index.html") if PLATFORM['darwin']        
       end
 
       desc "Generate and open flog report"
       if MetricFu::RAILS
         task :all => [:models, :controllers, :helpers, :lib] do
-          MetricFu::FlogReporter::Generator.generate_report(FLOG_DIR)
+          MetricFu.generate_flog_report
           system("open #{FLOG_DIR}/index.html") if PLATFORM['darwin']
         end
       else
         task :all => [:custom] do
-          MetricFu::FlogReporter::Generator.generate_report(FLOG_DIR)
+          MetricFu.generate_flog_report
           system("open #{FLOG_DIR}/index.html") if PLATFORM['darwin']
         end
       end

data/lib/tasks/metric_fu.rake

@@ -1,8 +1,8 @@
 namespace :metrics do
   if MetricFu::RAILS
 
-    desc "Generate coverage, cyclomatic complexity, flog, stats, duplication and churn reports"
-    task :all => [:coverage, :stats, :saikuro, :churn, :flog, :flay]
+    desc "Generate coverage, cyclomatic complexity, flog, flay, railroad, reek, roodi, stats and churn reports"
+    task :all => [:coverage, :stats, :saikuro, :churn, :flog, :flay, :railroad, :reek, :roodi]
 
     task :set_testing_env do
       RAILS_ENV = 'test'
@@ -13,8 +13,9 @@ namespace :metrics do
 
   else
 
-    desc "Generate coverage, cyclomatic complexity, flog, duplication and churn reports"
-    task :all => [:coverage, :saikuro, :churn, :flog, :flay]
+    desc "Generate coverage, cyclomatic complexity, flog, flay, railroad, reek, roodi and churn reports"
+    task :all => [:coverage, :saikuro, :churn, :flog, :flay, :railroad, :reek, :roodi]
 
   end
+
 end

data/lib/tasks/railroad.rake

@@ -0,0 +1,36 @@
+namespace :metrics do
+  
+  RAILROAD_DIR = File.join(MetricFu::BASE_DIRECTORY, 'railroad')
+  RAILROAD_INDEX = File.join(RAILROAD_DIR, 'index.html')
+  
+  task :railroad => ['railroad:all'] do
+  end
+  
+  namespace :railroad do
+  
+    desc "Create all railroad reports"
+    task :all => [:models, :controllers, :aasm] do
+      #system("open #{RAILROAD_INDEX}") if PLATFORM['darwin']
+    end
+  
+    desc "Create a railroad models report"
+    task :models do
+      mkdir_p(RAILROAD_DIR) unless File.directory?(RAILROAD_DIR)
+      `railroad -M -a -m -l -v | neato -Tpng > #{File.join(RAILROAD_DIR,'models.png')}`
+    end
+  
+    desc "Create a railroad controllers report"
+    task :controllers do
+      mkdir_p(RAILROAD_DIR) unless File.directory?(RAILROAD_DIR)
+      `railroad -C -l -v | neato -Tpng > #{File.join(RAILROAD_DIR,'controllers.png')}`
+    end
+  
+    desc "Create a railroad acts_as_state_machine report"
+    task :aasm do
+      mkdir_p(RAILROAD_DIR) unless File.directory?(RAILROAD_DIR)
+      `railroad -A -l -v | neato -Tpng > #{File.join(RAILROAD_DIR,'aasm.png')}`
+    end
+    
+  end
+
+end

data/lib/tasks/reek.rake

@@ -0,0 +1,14 @@
+namespace :metrics do
+  
+  REEK_DIR = File.join(MetricFu::BASE_DIRECTORY, 'reek')
+  REEK_FILE = File.join(REEK_DIR, 'index.html')
+  
+  desc "A code smell report using Reek"
+  task :reek do
+    mkdir_p(REEK_DIR) unless File.directory?(REEK_DIR)
+    `echo '<pre>' > #{REEK_FILE}`
+    `reek #{RAILS_ROOT}/test/**/*.rb #{RAILS_ROOT}/app/**/*.rb >> #{REEK_FILE}`
+    `echo '</pre>' >> #{REEK_FILE}`
+    system("open #{REEK_FILE}") if PLATFORM['darwin']
+  end
+end

data/lib/tasks/roodi.rake

@@ -0,0 +1,14 @@
+namespace :metrics do
+  
+  ROODI_DIR = File.join(MetricFu::BASE_DIRECTORY, 'roodi')
+  ROODI_FILE = File.join(ROODI_DIR, 'index.html')
+  
+  desc "A Ruby coding standards report using Roodi"
+  task :roodi do
+    mkdir_p(ROODI_DIR) unless File.directory?(ROODI_DIR)
+    `echo '<pre>' > #{ROODI_FILE}`
+    `roodi #{RAILS_ROOT}/lib/**/*.rb #{RAILS_ROOT}/app/**/*.rb >> #{ROODI_FILE}`
+    `echo '</pre>' >> #{ROODI_FILE}`
+    system("open #{ROODI_FILE}") if PLATFORM['darwin']
+  end
+end

data/lib/templates/churn.html.erb

@@ -2,7 +2,7 @@
 <head>
 	<title>Source Control Churn Results</title>
 	<style>
-	<%= open(File.join(MetricFu::TEMPLATE_DIR, "#{template_name}.css")) { |f| f.read } %>
+	<%= inline_css("#{template_name}.css") %>
 	</style>
 </head>
 

data/lib/templates/flay.html.erb

@@ -2,7 +2,7 @@
 <head>
 	<title>Flay Results</title>
 	<style>
-	<%= open(File.join(MetricFu::TEMPLATE_DIR, "#{template_name}.css")) { |f| f.read } %>
+	<%= inline_css("#{template_name}.css") %>
 	</style>
 </head>
 

data/lib/templates/flog.html.erb

@@ -2,7 +2,7 @@
 <head>
 	<title>Flog Reporter</title>
 	<style>
-	<%= open(File.join(MetricFu::TEMPLATE_DIR, "#{template_name}.css")) { |f| f.read } %>
+	<%= inline_css("#{template_name}.css") %>
 	</style>
 </head>
 <body>
@@ -10,16 +10,14 @@
 	<p>Generated on <%= Time.now.localtime %> with <a href='http://ruby.sadi.st/Flog.html'>flog</a></p>
 	<table class='report'>
 		<tr><th>File</th><th>Total score</th><th>Methods</th><th>Average score</th><th>Highest score</th></tr>
-		<% count = 0 %>
-		<% flog_hashes.sort {|x,y| y[:page].highest_score <=> x[:page].highest_score }.each do |flog_hash| %>
-		<tr class='<%= Base.cycle("light", "dark", count) %>'>
-			<td><a href='<%= flog_hash[:path]%>'><%= flog_hash[:path].sub('.html', '.rb') %></a></td>
-			<td class='score'><%= sprintf(SCORE_FORMAT, flog_hash[:page].score) %></td>
-			<td class='score'><%= flog_hash[:page].scanned_methods.length %></td>
-			<td class='score'><%= sprintf(SCORE_FORMAT, flog_hash[:page].average_score) %></td>
-			<td class='score'><%= sprintf(SCORE_FORMAT, flog_hash[:page].highest_score) %></td>
+		<% pages.sort {|x,y| y.highest_score <=> x.highest_score }.each_with_index do |page, count| %>
+		<tr class='<%= cycle("light", "dark", count) %>'>
+			<td><a href='<%= page.path %>'><%= page.path.sub('.html', '.rb') %></a></td>
+			<td class='score'><%= sprintf(SCORE_FORMAT, page.score) %></td>
+			<td class='score'><%=                       page.scanned_methods.length %></td>
+			<td class='score'><%= sprintf(SCORE_FORMAT, page.average_score) %></td>
+			<td class='score'><%= sprintf(SCORE_FORMAT, page.highest_score) %></td>
 		</tr>
-		<% count += 1 %>
 		<% end %>
 	</table>
 </body>

data/lib/templates/flog_page.html.erb

@@ -1,13 +1,22 @@
 <html>
 <head>
 	<style>
-	<%= open(File.join(MetricFu::TEMPLATE_DIR, "flog.css")) { |f| f.read } %>
+	<%= inline_css("flog.css") %>
 	</style>
 </head>
 <body>
 	<p>Score: <%= score %></p>
 	<% scanned_methods.each do |sm| %>
-	<%= sm.to_html %>
-	<% end %>
+  <p><strong><%= sm.name %> (<%= sm.score %>)</strong></p>
+  <table>
+    <tr><th>Score</th><th>Operator</th></tr>
+    <% sm.operators.each_with_index do |operator, count| %>
+      <tr class='<%= cycle("light", "dark", count) %>'>
+        <td class='score'><%= sprintf(SCORE_FORMAT, operator.score) %></td>
+        <td class='score'><%= operator.operator %></td>
+      </tr>
+    <% end %>
+  </table>
+ <% end %>
 </body>
 </html>

data/spec/base_spec.rb

@@ -32,4 +32,19 @@ describe MetricFu::Base::Generator do
       @generator.generate_report
     end
   end
+  
+  describe "cycle" do
+    it "should create a new Generator and call generate_report on it" do
+      @generator = MetricFu::Base::Generator.new('other_dir')      
+      @generator.cycle("light", "dark", 0).should == 'light'
+      @generator.cycle("light", "dark", 1).should == 'dark'      
+    end
+  end
+  
+  describe "template_name" do
+    it "should return the class name in lowercase" do
+      @generator = MetricFu::Base::Generator.new('other_dir')      
+      @generator.template_name.should == 'generator'
+    end
+  end  
 end

data/spec/churn_spec.rb

@@ -22,6 +22,13 @@ describe MetricFu::Churn do
     end
 
   end
+  
+  describe "template_name" do
+    it "should return the class name in lowercase" do
+      churn = Churn.new('base_dir')      
+      churn.template_name.should == 'churn'
+    end
+  end  
 
   describe "parse_log_for_changes" do
     it "should count the changes with git" do

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
+  
+  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,147 @@
+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
+
+  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.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/spec_helper.rb

@@ -3,8 +3,8 @@ require 'spec'
 require 'date'
 
 require File.join(File.dirname(__FILE__), '/../lib/metric_fu/base')
-require File.join(File.dirname(__FILE__), '/../lib/metric_fu/flay_reporter')
-require File.join(File.dirname(__FILE__), '/../lib/metric_fu/flog_reporter')
+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')
 include MetricFu

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: p8-metric_fu
 version: !ruby/object:Gem::Version 
-  version: 0.8.4
+  version: 0.8.4.1
 platform: ruby
 authors: 
 - Jake Scruggs
@@ -15,12 +15,30 @@ cert_chain: []
 date: 2008-12-22 00:00:00 -08:00
 default_executable: 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: factorylabs-railroad
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: 
+- !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: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
-    - - ">="
+    - - ">"
       - !ruby/object:Gem::Version 
         version: 1.2.0
     version: 
@@ -29,12 +47,12 @@ 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: reek
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -43,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: 
@@ -59,6 +77,7 @@ extensions: []
 
 extra_rdoc_files: 
 - HISTORY
+- Manifest.txt
 - README
 files: 
 - README
@@ -68,13 +87,8 @@ 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/md5_tracker.rb
 - lib/metric_fu/saikuro/saikuro.rb
 - lib/metric_fu.rb
@@ -84,6 +98,9 @@ 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
@@ -93,6 +110,7 @@ files:
 - lib/templates/flog.css
 - lib/templates/flog.html.erb
 - lib/templates/flog_page.html.erb
+- Manifest.txt
 has_rdoc: true
 homepage: http://metric-fu.rubyforge.org/
 post_install_message: 
@@ -123,7 +141,7 @@ 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/flay_spec.rb
+- spec/flog_spec.rb
 - spec/md5_tracker_spec.rb
 - spec/spec_helper.rb

data/lib/metric_fu/flog_reporter.rb

@@ -1,5 +0,0 @@
-require File.join(File.dirname(__FILE__), 'flog_reporter', 'base')
-require File.join(File.dirname(__FILE__), 'flog_reporter', 'page')
-require File.join(File.dirname(__FILE__), 'flog_reporter', 'scanned_method')
-require File.join(File.dirname(__FILE__), 'flog_reporter', 'operator')
-require File.join(File.dirname(__FILE__), 'flog_reporter', 'generator')

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

data/lib/metric_fu/flog_reporter/generator.rb

@@ -1,39 +0,0 @@
-module MetricFu::FlogReporter
-  class Generator < MetricFu::Base::Generator
-    def generate_report
-      flog_hashes = []
-      Dir.glob("#{@base_dir}/**/*.txt").each do |filename|
-        begin
-          page = Base.parse(open(filename, "r") { |f| f.read })
-        rescue InvalidFlog
-          puts "Invalid flog for #{filename}"
-          next
-        end
-
-        next unless page
-
-        unless MetricFu::MD5Tracker.file_already_counted?(filename)
-          generate_page(filename, page)
-        end
-        flog_hashes << { :path => File.basename(filename, ".txt") + '.html',
-                 :page => page }
-      end
-
-      generate_index(flog_hashes)
-    end
-
-    def generate_page(filename, page)
-      save_html(page.to_html, File.basename(filename, ".txt"))
-    end
-
-    # should be dynamically read from the class
-    def template_name
-      'flog'
-    end
-
-    def generate_index(flog_hashes)
-      html = ERB.new(File.read(template_file)).result(binding)
-      save_html(html)
-    end
-  end
-end

data/lib/metric_fu/flog_reporter/operator.rb

@@ -1,10 +0,0 @@
-module MetricFu::FlogReporter
-  class Operator
-    attr_accessor :score, :operator
-
-    def initialize(score, operator)
-      @score = score.to_f
-      @operator = operator
-    end
-  end
-end

data/lib/metric_fu/flog_reporter/page.rb

@@ -1,34 +0,0 @@
-module MetricFu::FlogReporter
-  class Page < MetricFu::Base::Generator
-    attr_accessor :score, :scanned_methods
-
-    def initialize(score, scanned_methods = [])
-      @score = score.to_f
-      @scanned_methods = scanned_methods
-    end
-
-    def to_html
-      ERB.new(File.read(template_file)).result(binding)
-    end
-
-    def average_score
-      return 0 if scanned_methods.length == 0
-      sum = 0
-      scanned_methods.each do |m|
-        sum += m.score
-      end
-      sum / scanned_methods.length
-    end
-
-    def highest_score
-      scanned_methods.inject(0) do |highest, m|
-        m.score > highest ? m.score : highest
-      end
-    end
-
-    # should be dynamically read from the class
-    def template_name
-      'flog_page'
-    end
-  end
-end

data/lib/metric_fu/flog_reporter/scanned_method.rb

@@ -1,28 +0,0 @@
-module MetricFu::FlogReporter
-  class ScannedMethod
-    attr_accessor :name, :score, :operators
-
-    def initialize(name, score, operators = [])
-      @name = name
-      @score = score.to_f
-      @operators = operators
-    end
-
-    def to_html
-      output = "<p><strong>#{name} (#{score})</strong></p>\n"
-      output << "<table>\n"
-      output << "<tr><th>Score</th><th>Operator</th></tr>\n"
-      count = 0
-      operators.each do |operator|
-        output << <<-EOF
-                    <tr class='#{Base.cycle("light", "dark", count)}'>
-                      <td class='score'>#{sprintf(SCORE_FORMAT, operator.score)}</td>
-                      <td class='score'>#{operator.operator}</td>
-                    </tr>
-                  EOF
-        count += 1
-      end
-      output << "</table>\n\n"
-    end
-  end
-end

data/spec/flog_reporter/base_spec.rb

@@ -1,86 +0,0 @@
-require File.dirname(__FILE__) + '/../spec_helper.rb'
-include MetricFu::FlogReporter
-
-describe "FlogReporter::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
-  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
-end
-
-
-describe MetricFu::FlogReporter::Page do
-
-  describe "average_score" do
-    it "should calculate the average score" do
-      page = MetricFu::FlayReporter::Page.new('other_dir')
-      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 = MetricFu::FlayReporter::Page.new('other_dir')
-      page.should_receive(:scanned_methods).any_number_of_times.and_return([])
-      page.average_score.should == 0
-    end    
-  end
-end