factorylabs-metric_fu 0.8.0.4

data/lib/metric_fu.rb

@@ -0,0 +1,7 @@
+module MetricFu
+  BASE_DIRECTORY = ENV['CC_BUILD_ARTIFACTS'] || 'tmp/metric_fu'
+end
+
+require File.join(File.dirname(__FILE__), 'metric_fu', 'md5_tracker')
+require File.join(File.dirname(__FILE__), 'metric_fu', 'flog_reporter')
+require File.join(File.dirname(__FILE__), 'tasks', 'metric_fu')

data/lib/tasks/churn.rake

@@ -0,0 +1,11 @@
+require File.join(File.dirname(__FILE__), '../metric_fu/churn')
+
+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']
+  end
+end

data/lib/tasks/coverage.rake

@@ -0,0 +1,40 @@
+require 'fileutils'
+
+begin
+  require 'rcov'
+  require 'rcov/rcovtask'
+
+  namespace :metrics do
+
+    COVERAGE_DIR = File.join(MetricFu::BASE_DIRECTORY, 'coverage')
+    COVERAGE_DATA_FILE = File.join(MetricFu::BASE_DIRECTORY, 'coverage.data')
+
+    namespace :coverage do
+      rcov_output = COVERAGE_DIR
+      
+      desc "Delete aggregate coverage data."
+      task(:clean) { rm_f("rcov_tmp", :verbose => false) }
+
+      desc "RCov task to generate report"
+      Rcov::RcovTask.new(:do => :clean) do |t|
+        FileUtils.mkdir_p(MetricFu::BASE_DIRECTORY) unless File.directory?(MetricFu::BASE_DIRECTORY)
+        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
+    end
+    
+    desc "Generate and open coverage report"
+    task :coverage => ['coverage:do'] do
+      system("open #{COVERAGE_DIR}/index.html") if PLATFORM['darwin']
+    end
+  end
+rescue LoadError
+  if RUBY_PLATFORM =~ /java/
+    puts 'running in jruby - rcov tasks not available'
+  else
+    puts 'sudo gem install rcov # if you want the rcov tasks'
+  end
+end

data/lib/tasks/flay.rake

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

data/lib/tasks/flog.rake

@@ -0,0 +1,62 @@
+begin
+  FLOG_DIR = File.join(MetricFu::BASE_DIRECTORY, 'flog')
+
+  def flog(output, directory)
+    Dir.glob("#{directory}/**/*.rb").each do |filename|
+      output_dir = "#{FLOG_DIR}/#{filename.split("/")[0..-2].join("/")}"
+      mkdir_p(output_dir, :verbose => false) unless File.directory?(output_dir)
+      `flog #{filename} > #{FLOG_DIR}/#{filename.split('.')[0]}.txt` if MetricFu::MD5Tracker.file_changed?(filename, FLOG_DIR)
+    end
+  end
+
+  namespace :metrics do
+  
+    task :flog => ['flog:all'] do
+    end
+    
+    namespace :flog do
+      desc "Delete aggregate flog data."
+      task(:clean) { rm_rf(FLOG_DIR, :verbose => false) }
+  
+      desc "Flog code in app/models"
+      task :models do
+        flog "models", "app/models"
+      end
+
+      desc "Flog code in app/controllers"  
+      task :controllers do
+        flog "controllers", "app/controllers"
+      end
+
+      desc "Flog code in app/helpers"  
+      task :helpers do
+        flog "helpers", "app/helpers"
+      end
+
+      desc "Flog code in lib"  
+      task :lib do
+        flog "lib", "lib"
+      end  
+
+      desc "Generate and open flog report"
+      task :all => [:models, :controllers, :helpers, :lib] do
+        MetricFu::FlogReporter::Generator.generate_report(FLOG_DIR)
+        system("open #{FLOG_DIR}/index.html") if PLATFORM['darwin']
+      end
+      
+      desc "Generate a flog report from specified directories"
+      task :custom do
+        raise "You must define MetricFu::DIRECTORIES_TO_FLOG in your Rakefile" unless defined?(MetricFu::DIRECTORIES_TO_FLOG)
+        MetricFu::DIRECTORIES_TO_FLOG.each { |directory| flog(directory, directory) }
+        MetricFu::FlogReporter::Generator.generate_report(FLOG_DIR)
+      end      
+    end
+
+  end
+rescue LoadError
+  if RUBY_PLATFORM =~ /java/
+    puts 'running in jruby - flog tasks not available'
+  else
+    puts 'sudo gem install flog # if you want the flog tasks'
+  end
+end

data/lib/tasks/metric_fu.rake

@@ -0,0 +1,11 @@
+namespace :metrics do
+  task :prepare do
+    RAILS_ENV = 'test'
+  end
+  
+  desc "Useful for continuous integration"
+  task :all_with_migrate => [:prepare, "db:migrate", :all]
+  
+  desc "Generate coverage, cyclomatic complexity (saikuro), flog, stats, and churn reports"
+  task :all => [:coverage, :saikuro, :flog, :churn, :stats, :railroad, :reek, :roodi, :flay]
+end

data/lib/tasks/metric_fu.rb

@@ -0,0 +1,6 @@
+require 'fileutils'
+require 'rubygems'
+require 'rake'
+
+# Load rake files
+Dir["#{File.dirname(__FILE__)}/*.rake"].each { |ext| load ext }

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/tasks/saikuro.rake

@@ -0,0 +1,34 @@
+namespace :metrics do
+  
+  SAIKURO_DIR = File.join(MetricFu::BASE_DIRECTORY, 'saikuro')
+  
+  desc "A cyclomatic complexity report using Saikuro"
+  task :saikuro do
+    raise "SAIKURO_OPTIONS is now MetricFu::SAIKURO_OPTIONS" if defined?(SAIKURO_OPTIONS)
+    default_options = {"--output_directory" => SAIKURO_DIR,
+                        "--input_directory" => "app",
+                        "--cyclo" => "",
+                        "--filter_cyclo" => "0",
+                        "--warn_cyclo" => "5",
+                        "--error_cyclo" => "7"}
+  
+    default_options.merge!(MetricFu::SAIKURO_OPTIONS) if defined?(MetricFu::SAIKURO_OPTIONS)
+    options = ""
+    default_options.each_pair { |key, value| options << "#{key} #{value} " }  
+     
+    sh "ruby \"#{File.expand_path(File.join(File.dirname(__FILE__), '..', 'metric_fu', 'saikuro'))}/saikuro.rb\" " +
+                "#{options}" do |ok, response|
+      unless ok
+        puts "Saikuro failed with exit status: #{response.exitstatus}"
+        exit 1
+      end
+    end
+
+    if File.exist? "#{SAIKURO_DIR}/index_cyclo.html"
+      mv "#{SAIKURO_DIR}/index_cyclo.html", 
+         "#{SAIKURO_DIR}/index.html"
+    end
+    
+    system("open #{SAIKURO_DIR}/index.html") if PLATFORM['darwin']
+  end
+end

data/lib/tasks/stats.rake

@@ -0,0 +1,14 @@
+namespace :metrics do
+  
+  STATS_DIR = File.join(MetricFu::BASE_DIRECTORY, 'stats')
+  STATS_FILE = File.join(STATS_DIR, 'index.html')
+  
+  desc "A stats report"
+  task :stats do
+    mkdir_p(STATS_DIR) unless File.directory?(STATS_DIR)
+    `echo '<pre>' > #{STATS_FILE}`
+    `rake stats >> #{STATS_FILE}`
+    `echo '</pre>' >> #{STATS_FILE}`
+    system("open #{STATS_FILE}") if PLATFORM['darwin']
+  end
+end

data/metric_fu.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+  s.name = "metric_fu"
+  s.version = "0.8.0.4"
+  s.summary = "Generates project metrics using Flog, RCov, Saikuro, Flay, Reek, Roodi, Railroad 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/churn.rb", "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/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"]
+  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"])
+  s.add_dependency("reek", ["> 0.0.0"])
+  s.add_dependency("flay", ["> 0.0.0"])
+  s.add_dependency("roodi", ["> 0.0.0"])
+  s.add_dependency("factorylabs-railroad", ["> 0.0.0"])
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification 
+name: factorylabs-metric_fu
+version: !ruby/object:Gem::Version 
+  version: 0.8.0.4
+platform: ruby
+authors: 
+- Jake Scruggs
+- Sean Soper
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-22 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: flog
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.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: 
+- !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: roodi
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: 
+- !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: 
+description: Gives you a fist full of code metrics
+email: jake.scruggs@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README
+files: 
+- History.txt
+- Manifest.txt
+- metric_fu.gemspec
+- MIT-LICENSE
+- README
+- TODO.txt
+- lib/metric_fu
+- lib/metric_fu/churn.rb
+- 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/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
+has_rdoc: true
+homepage: http://metric-fu.rubyforge.org/
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Generates project metrics using Flog, RCov, Saikuro, Flay, Reek, Roodi, Railroad and more
+test_files: 
+- test/test_md5_tracker.rb