jscruggs-metric_fu 0.8.0 → 0.8.9

metadata

@@ -1,20 +1,22 @@
 --- !ruby/object:Gem::Specification 
 name: jscruggs-metric_fu
 version: !ruby/object:Gem::Version 
-  version: 0.8.0
+  version: 0.8.9
 platform: ruby
 authors: 
 - Jake Scruggs
 - Sean Soper
+- Andre Arko
+- Petrik de Heus
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2008-08-13 00:00:00 -07:00
+date: 2009-01-11 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: flog
+  name: flay
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
@@ -22,56 +24,95 @@ dependencies:
       - !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: 
 - !ruby/object:Gem::Dependency 
   name: rcov
   version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.8.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  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: 
     - - ">"
       - !ruby/object:Gem::Version 
         version: 0.0.0
     version: 
-description: Gives you a fist full of code metrics
+- !ruby/object:Gem::Dependency 
+  name: roodi
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: 
+description: Code metrics from Flog, Flay, RCov, Saikuro, Churn, Reek, Roodi and Rails' stats task
 email: jake.scruggs@gmail.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- History.txt
+- HISTORY
 - Manifest.txt
 - README
 files: 
-- History.txt
-- Manifest.txt
-- metric_fu.gemspec
-- MIT-LICENSE
 - README
-- TODO.txt
-- lib/metric_fu
-- lib/metric_fu/flog_reporter
-- 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/flog_reporter.rb
+- HISTORY
+- TODO
+- MIT-LICENSE
+- Rakefile
+- lib/metric_fu/base.rb
+- lib/metric_fu/churn.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
 - lib/metric_fu/saikuro/saikuro.rb
-- lib/metric_fu/saikuro/SAIKURO_README
 - lib/metric_fu.rb
-- lib/tasks
+- lib/tasks/metric_fu.rb
 - lib/tasks/churn.rake
 - lib/tasks/coverage.rake
+- lib/tasks/flay.rake
 - lib/tasks/flog.rake
 - lib/tasks/metric_fu.rake
-- lib/tasks/metric_fu.rb
+- lib/tasks/railroad.rake
+- lib/tasks/reek.rake
+- lib/tasks/roodi.rake
 - lib/tasks/saikuro.rake
 - lib/tasks/stats.rake
-- test/test_helper.rb
-- test/test_md5_tracker.rb
+- lib/templates/churn.html.erb
+- lib/templates/default.css
+- lib/templates/flay.html.erb
+- 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: 
@@ -98,6 +139,14 @@ rubyforge_project:
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: Generates project metrics using Flog, RCov, Saikuro and more
+summary: A fistful of code metrics
 test_files: 
-- test/test_md5_tracker.rb
+- spec/base_spec.rb
+- spec/churn_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/TODO.txt

@@ -1,9 +0,0 @@
-== TODO list
-
-* Color code flog results with scale from: http://jakescruggs.blogspot.com/2008/08/whats-good-flog-score.html
-* Extract functionality from rake files and put under test
-* Change churn start_date to not rely on Rails 1.day.ago functionality (so metric_fu can be used in non-Rails apps)
-* Make integration with RSpec better (use SpecTask?)
-* Integrate Flog, Saikuro, and Coverage into one report so you can see methods that have high complexity and low coverage (this is a big one)
-* Integrate MD5 hashing with remainder of reports
-

data/lib/metric_fu/flog_reporter/base.rb

@@ -1,58 +0,0 @@
-module MetricFu::FlogReporter
-  
-  SCORE_FORMAT = "%0.2f"
-  
-  class InvalidFlog < RuntimeError
-  end
-  
-  class Base
-    MODULE_NAME = "([A-Z][a-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 load_css(css_file = nil)
-        filepath = css_file || File.join(File.dirname(__FILE__), 'flog_reporter.css')
-        css = ""
-        file = File.open(filepath, "r")
-        file.each_line { |line| css << line }
-        file.close
-        css
-      end
-
-      def parse(text)
-        score = text[/score = (\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/flog_reporter.css

@@ -1,39 +0,0 @@
-body { 
-	background-color: rgb(240, 240, 245);
-	font-family: verdana, arial, helvetica;
-}
-
-table {
-	border-collapse: collapse;
-}
-
-table.report {
-	width: 100%;
-}
-
-table th {
-	text-align: center;
-}
-
-table td.score {
-	text-align: right;
-}
-
-table th {
-	background: #dcecff;
-	border: #d0d0d0 1px solid;
-	font-weight: bold;
-}
-
-table td {
-	border: #d0d0d0 1px solid;
-}
-
-table tr.light {
- background-color: rgb(240, 240, 245);
-}
-
-table tr.dark {
- background-color: rgb(230, 230, 235);
-}
-

data/lib/metric_fu/flog_reporter/generator.rb

@@ -1,71 +0,0 @@
-module MetricFu::FlogReporter
-  class Generator
-    class << self
-      def generate_report(base_dir)
-        flog_hashes = []
-        Dir.glob("#{base_dir}/**/*.txt").each do |filename|
-          content = ""
-          File.open(filename, "r").each_line do |file|
-            content << file
-          end
-
-          begin
-            page = Base.parse(content)
-          rescue InvalidFlog
-            puts "Invalid flog for #{filename}"
-            next
-          end
-
-          next unless page
-
-          if MetricFu::MD5Tracker.file_already_counted?(filename)            
-            flog_hashes << {
-              :page => page,
-              :path => filename.sub('.txt', '.html').sub("#{base_dir}/", "")
-            }
-          else  
-            flog_hashes << generate_page(filename, page, base_dir)
-          end
-        end
-        
-        generate_index(flog_hashes, base_dir)
-      end
-
-      def generate_page(filename, page, base_dir)
-        html_file = File.new(filename.gsub(/\.txt/, '.html'), "w")
-        html_file.puts page.to_html
-        html_file.close
-        return { :path => html_file.path.sub("#{base_dir}/", ''),
-                 :page => page }
-      end
-
-      def generate_index(flog_hashes, base_dir)
-        html = "<html><head><title>Flog Reporter</title><style>"
-        html << Base.load_css
-        html << "</style></head><body>"
-        html << "<p><strong>Flogged files</strong></p>\n"
-        html << "<p>Generated on #{Time.now.localtime} with <a href='http://ruby.sadi.st/Flog.html'>flog</a></p>\n"
-        html << "<table class='report'>\n"
-        html << "<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|
-          html << <<-EOF
-                    <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>
-                    </tr>
-                  EOF
-          count += 1
-        end
-        html << "</table>\n"
-        html << "</body></html>\n"
-        index = File.new("#{base_dir}/index.html", "w")
-        index.puts html
-        index.close
-      end
-    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,36 +0,0 @@
-module MetricFu::FlogReporter
-  class Page
-    attr_accessor :score, :scanned_methods
-    
-    def initialize(score, scanned_methods = [])
-      @score = score.to_f
-      @scanned_methods = scanned_methods
-    end
-    
-    def to_html
-      output = "<html><head><style>"
-      output << Base.load_css
-      output << "</style></head><body>"
-      output << "Score: #{score}\n"
-      scanned_methods.each do |sm|
-        output << sm.to_html
-      end
-      output << "</body></html>"
-      output
-    end
-    
-    def average_score
-      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
-  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/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/saikuro/SAIKURO_README

@@ -1,142 +0,0 @@
-Version 0.2
-
-Saikuro:
-Saikuro is a Ruby cyclomatic complexity analyzer.  When given Ruby
-source code Saikuro will generate a report listing the cyclomatic
-complexity of each method found.  In addition, Saikuro counts the
-number of lines per method and can generate a listing of the number of
-tokens on each line of code.
-
-License:
-Saikuro uses the BSD license.
-
-Installation:
-Option 1: Using setup.rb
-* login as root
-* run "ruby setup.rb all"
-
-Option 2: The manual way
-Saikuro is a single Ruby file that is executable.  You can run it where
-you unpacked it or you can move it your preferred location such as
-"/usr/local/bin" or "~/bin".
-
-Note:
-Ruby 1.8.5 has a bug in ri_options that will prevent Saikuro from
-running.  If you are using 1.8.5 please apply this patch :
-http://www.ruby-lang.org/cgi-bin/cvsweb.cgi/ruby/lib/rdoc/ri/ri_options.rb.diff?r1=1.2.2.13;r2=1.2.2.14
-
-
-Usage:
-Saikuro is a command line program.
-Running "saikuro -h" will output a usage statement describing all
-the various arguments you can pass to it.
-
-"saikuro -c -p tests/samples.rb"
-
-The above command is a simple example that generates a cyclomatic
-complexity report on the samples.rb file, using the default filter,
-warning and error settings. The report is saved in the current
-directory.
-
-
-A more detailed example is
-"saikuro -c -t -i tests -y 0 -w 11 -e 16 -o out/"
-
-This will analyze all Ruby files found in the "tests/" directory.
-Saikuro will generate a token count report and a cyclomatic complexity
-report in the "out" directory .  The "-y 0" command will turn off
-filtering and thus show the complexity of all methods.  The "-w 11"
-will mark all methods with a complexity of 11 or higher with a
-warning.  Finally, "-e 16" will flag all methods with a complexity of
-16 or higher with an error.
-
-
-About Cyclomatic Complexity:
-
-The following document provides a very good and detailed description
-by the author of cyclomatic complexity.
-
-NIST Special Publication 500-235
-Structured Testing: A Testing Methodology Using the Cyclomatic
-Complexity Metric
-
-By Arthur H. Watson and Thomas J. McCabe
-HTML
-http://hissa.nist.gov/HHRFdata/Artifacts/ITLdoc/235/title.htm
-PDF
-http://www.mccabe.com/iq_research_nist.htm
-
-
-How and what Saikuro counts to calculate the cyclomatic complexity:
-
-Saikuro uses the Simplified Complexity Calculation, which is just
-adding up the number of branch points in a method.
-
-Each method starts with a complexity of 1, because there is at least
-one path through the code.  Then each conditional or looping operator
-(if, unless, while, until, for, elsif, when) adds one point to the
-complexity. Each "when" in a case statement adds one point.  Also each
-"rescue" statement adds one.
-
-Saikuro also regards blocks as an addition to a method's complexity
-because in many cases a block does add a path that may be traversed.
-For example, invoking the "each" method of an array with a block would
-only traverse the give block if the array is not empty.  Thus if you
-want to find the basis set to get 100% coverage of your code then a
-block should add one point to the method's complexity.  It is not yet
-for sure however to what level the accuracy is decreased through this
-measurement, as normal Ruby code uses blocks quite heavily and new
-paths are not necessarily introduced by every block.
-
-In addition, the short-circuiting "and" operators (&& and "and")
-currently do not contribute to a method's complexity, although
-McCabe's paper listed above suggests doing so.
-
-
-#Example for "and" operator handling:
-
- # Starting values for case 1 and 2
- x = false
- y = 15
- r, q = nil
-
- # case 1
- puts "W" if ((r = x) && (q = y))
- puts r # => false
- puts q # => nil
-
- # case 2
- puts "W" if ((q = y) && (r = x))
- puts r # => false
- puts q # => 15
-
-Case 1 illustrates why "and" operators should add to a method's
-complexity, because the result of ( r = x ) is false the if statement
-stops and returns false without evaluating the ( q = y ) branch.  Thus
-if a total coverage of source code is desired, one point should be
-added to the method's complexity.
-
-So why is it not added?
-Mainly, because we have not gotten around to it.  We are wondering if
-this would increase the noise more than it should.
-
-
-Tests:
-In the test directory is a sample file that has examples of the
-various possible cases that we examined and documented the expected
-cyclomatic complexity result.  If you find mistakes or missing tests
-please report them.
-
-Contact:
-Saikuro is written by
-Zev Blut (zb at ubit dot com)
-
-Acknowledgments:
-Thanks to Elbert Corpuz for writing the CSS for the HTML output!
-
-Other metric tools for Ruby:
-Ryan Davis has an abc metric program as an example in his ParseTree
-product:  http://www.zenspider.com/ZSS/Products/ParseTree/
-
-The PMD project has a tool called CPD that can scan Ruby source code
-looking for source duplication:  http://pmd.sourceforge.net/

data/metric_fu.gemspec

@@ -1,16 +0,0 @@
-Gem::Specification.new do |s|
-  s.name = "metric_fu"
-  s.version = "0.8.0"
-  s.summary = "Generates project metrics using Flog, RCov, Saikuro and more"
-  s.email = "jake.scruggs@gmail.com"
-  s.homepage = "http://metric-fu.rubyforge.org/"
-  s.description = "Gives you a fist full of code metrics"
-  s.has_rdoc = true
-  s.authors = ["Jake Scruggs", "Sean Soper"]
-  s.files = ["History.txt", "Manifest.txt", "metric_fu.gemspec", "MIT-LICENSE", "README", "TODO.txt", "lib/metric_fu", "lib/metric_fu/flog_reporter", "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/flog_reporter.rb", "lib/metric_fu/md5_tracker.rb", "lib/metric_fu/saikuro", "lib/metric_fu/saikuro/saikuro.rb", "lib/metric_fu/saikuro/SAIKURO_README", "lib/metric_fu.rb", "lib/tasks", "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"]
-  s.test_files = ["test/test_md5_tracker.rb"]
-  s.rdoc_options = ["--main", "README"]
-  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README"]
-  s.add_dependency("flog", ["> 0.0.0"])
-  s.add_dependency("rcov", ["> 0.0.0"])
-end

data/test/test_helper.rb

@@ -1,4 +0,0 @@
-require 'test/unit'
-require 'fileutils'
-
-ENV['CC_BUILD_ARTIFACTS'] = File.join(File.dirname(__FILE__), 'tmp')

data/test/test_md5_tracker.rb

@@ -1,59 +0,0 @@
-require File.join(File.dirname(__FILE__), 'test_helper')
-
-class TestMD5Tracker < Test::Unit::TestCase
-
-  def setup
-    @tmp_dir = File.join(File.dirname(__FILE__), 'tmp')
-    FileUtils.mkdir_p(@tmp_dir, :verbose => false) unless File.directory?(@tmp_dir)
-    @file1 = File.new(File.join(@tmp_dir, 'file1.txt'), 'w')
-    @file2 = File.new(File.join(@tmp_dir, 'file2.txt'), 'w')
-  end
-  
-  def teardown
-    FileUtils.rm_rf(@tmp_dir, :verbose => false)
-  end
-  
-  def test_identical_files_match
-    @file1.puts("Hello World")
-    @file1.close
-    file1_md5 = MetricFu::MD5Tracker.track(@file1.path, @tmp_dir)
-    
-    @file2.puts("Hello World")
-    @file2.close
-    file2_md5 = MetricFu::MD5Tracker.track(@file2.path, @tmp_dir)
-    
-    assert file1_md5 == file2_md5
-  end
-  
-  def test_different_files_dont_match
-    @file1.puts("Hello World")
-    @file1.close
-    file1_md5 = MetricFu::MD5Tracker.track(@file1.path, @tmp_dir)
-
-    @file2.puts("Goodbye World")
-    @file2.close
-    file2_md5 = MetricFu::MD5Tracker.track(@file2.path, @tmp_dir)
-    
-    assert file1_md5 != file2_md5
-  end
-  
-  def test_file_changed
-    @file2.close
-    
-    @file1.puts("Hello World")
-    @file1.close
-    file1_md5 = MetricFu::MD5Tracker.track(@file1.path, @tmp_dir)
-
-    @file1 = File.new(File.join(@tmp_dir, 'file1.txt'), 'w')
-    @file1.puts("Goodbye World")
-    @file1.close
-    assert MetricFu::MD5Tracker.file_changed?(@file1.path, @tmp_dir)
-  end
-  
-  def test_file_changed_if_not_tracking
-    @file2.close
-    
-    assert MetricFu::MD5Tracker.file_changed?(@file1.path, @tmp_dir)
-    assert File.exist?(MetricFu::MD5Tracker.md5_file(@file1.path, @tmp_dir))
-  end
-end